Skip to content

Commit

Permalink
📝 more doc
Browse files Browse the repository at this point in the history
  • Loading branch information
CXwudi committed May 22, 2021
1 parent 3897170 commit 0c79e56
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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.

0 comments on commit 0c79e56

Please sign in to comment.