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

update README

Browse source 
Signed-off-by: ふぁ <yuki@yuki0311.com>
This commit is contained in:
ふぁ 2023-04-21 21:44:45 +09:00
parent 6aa291cc42
commit f45f2c4514
No known key found for this signature in database
GPG key ID: 83A8A5E74872A8AA
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -5,6 +5,19 @@ Twitter OpenAPI(Swagger) specification
- [Dart](https://github.com/fa0311/twitter_openapi_dart)
- [React Documents](https://github.com/fa0311/twitter-openapi-docs)
## Usage
```shell
openapi-generator-cli generate -g <language> -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/openapi-3.0.yaml -o ./generated
```
Note that the license also inherits to the output.
## Contribute
- `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json)
- `dist` Do not rewrite this file as it is an automatically generated OpenAPI file.
## License
[agpl-3.0](./LICENSE.txt)