OpenAPI

Map Accorudo types to OpenAPI with JSDoc annotations.

Accorudo is cross-compatible with OpenAPI. With its CLI, it provides a two-way bridge between an OpenAPI spec and TypeScript definitions.

Warning!

Due to the nature in how Accorudo understands components, re-generation of an externally supplied OpenAPI spec will most likely not result with the initially provided spec file.

Next steps

OpenAPI annotations: JSDoc flags for components, parameters, and responses
CLI: install, init, and daily commands
Import: generate a contract set from a spec
Export: generate a spec from contracts

Edit this page

Export

Generate an OpenAPI spec from Accorudo contracts.

OpenAPI annotations

JSDoc flags and fields that map Accorudo types to OpenAPI components, parameters, and responses.