/twitter-openapi

OpenAPI(Swagger) specification of Twitter Internal API

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

Twitter OpenAPI

Twitter OpenAPI(Swagger) specification

Usage

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.

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
  • dist Do not rewrite this file as it is an automatically generated OpenAPI file.

About build

  • src/openapi/**/*.yaml#/paths/*/get/parameters will be overwritten by src/config/parameters.yaml#/paths/~1parameters/get/parameters
  • src/openapi/**/*.yaml#/paths/*/get/responses/200/headers will be overwritten by src/config/headers.yaml#/components/headers
python -V # Python 3.10.8
pip install -r requirements.txt
python tools/build.py

License

agpl-3.0