From 0c79e56b05d151fee8d19ee5cfa7a40ea2e7b728 Mon Sep 17 00:00:00 2001 From: CXwudi Date: Sat, 22 May 2021 18:05:39 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20more=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5d7afc3..a14dcad 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,9 @@ A sample VocaDB API Java Client that is auto-generated by [OpenAPI](https://gith The original README file coming from this auto-generated client is in [README Original.md](./README%20Original.md) -The auto-generation cli for this client is: -``` +This client is generated by: + +``` shell openapi-generator-cli generate \ --api-package cx.mikufan.vocadbapiclient.api \ --model-package cx.mikufan.vocadbapiclient.model \ @@ -25,6 +26,18 @@ openapi-generator-cli generate \ --library resttemplate \ -o vocadb-api-client-resttemplate ``` -## How to use + +## Installation Refer to [jitpack](https://jitpack.io/#CXwudi/autogen-vocadb-openapi-java-client/1.0.0) + +## How to use + +Please read VocaDB API Usage [Rules](https://github.com/VocaDB/vocadb/wiki/Public-API#api-usage-rules) before using this API client. + +Refer to the [generated documentation](./README%20Original.md#Documentation%20for%20API%20Endpoints) for how to use this client + +## Notes + +- Highly recommended to set your custom User-Agent in `ApiClient` for VocaDB to identity you +- This client probably won't work well for any non-GET requests. Base on VocaDB [document](https://github.com/VocaDB/vocadb/wiki/Public-API#authenticated-apis), you need to set some custom header to be able to use it. \ No newline at end of file