mirror of
https://github.com/thegeneralist01/twitter-openapi
synced 2026-01-11 23:50:26 +01:00
37 lines
1 KiB
Markdown
37 lines
1 KiB
Markdown
# Twitter OpenAPI
|
|
|
|
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/typescript/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
|
|
```
|
|
|
|
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.
|
|
|
|
### build
|
|
|
|
```shell
|
|
python -V # Python 3.10.8
|
|
pip install -r requirements.txt
|
|
python tools/build.py
|
|
```
|
|
|
|
## License
|
|
|
|
[agpl-3.0](./LICENSE.txt)
|