1
Fork 0
mirror of https://github.com/thegeneralist01/twitter-openapi synced 2026-01-11 23:50:26 +01:00
twitter-openapi/README.md
ふぁ 15076eaa42
update README
Signed-off-by: ふぁ <yuki@yuki0311.com>
2023-06-13 15:33:34 +09:00

1.2 KiB

Twitter OpenAPI

Twitter OpenAPI(Swagger) specification

Usage

openapi-generator-cli generate -g <language> -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/docs/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

Note that the license also inherits to the output.

Contribute

  • src *.yaml files should be written according to the v3.0/schema.json
  • dist Do not rewrite this file as it is an automatically generated OpenAPI file.

build

python -V # Python 3.10.8
pip install -r requirements.txt
python tools/build.py

License

agpl-3.0