thegeneralist01/twitter-openapi
1
Fork 0
mirror of https://github.com/thegeneralist01/twitter-openapi synced 2026-01-11 15:40:26 +01:00
Code Issues Activity

update README

Browse source 
Signed-off-by: ふぁ <yuki@yuki0311.com>
This commit is contained in:
ふぁ 2023-06-13 15:33:34 +09:00
parent 705fdc83ec
commit 15076eaa42
No known key found for this signature in database
GPG key ID: 83A8A5E74872A8AA
1 changed files with 4 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -9,14 +9,12 @@ Twitter OpenAPI(Swagger) specification
## Usage
```shell
openapi-generator-cli generate -g <language> -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/typescript/openapi-3.0.yaml -o ./generated
openapi-generator-cli generate -g <language> -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/docs/openapi-3.0.yaml -o ./generated
```
If the language supports variable-length arguments.
```shell
openapi-generator-cli generate -g <language> -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/dart/openapi-3.0.yaml -o ./generated
```
There are several outputs, but the one that best follows the OpenAPI specification is `dist/docs`.
However, some Generators may use a syntax that is not supported.
You can also modify the hook to make the generated results more user-friendly. [build_config.py](./tools/build_config.py)
Note that the license also inherits to the output.