Topsort OpenAPI

Topsort uses the OpenAPI 3.1.0 specification to document our APIs and we recommend our clients to use these specifications to generate supported client libraries and server scaffolding. This would provide a consistent and robust developer experience across languages.

You can additionally consume the entire Topsort OpenAPI spec available here.

Validating the file

• Use prettier to format the documents: bunx prettier -w
• Use yamllint to validate the documents: uvx yamllint *.yml
• Use vacuum to validate the openapi standard: vacuum *.yml
• Use redocly to further validate the openapi standard: bunx @redocly/cli lint *.yml
• Use typos to fix language typos: typos .

Using the OpenAPI generator

You can find examples on the official OpenAPI Generator docs.