Convert an OpenAPI specification into documentation
OpenAPI is an API description format for REST APIs. The government’s Open Standards Board recommends using OpenAPI.
You can convert an OpenAPI file into an API reference page in your documentation.
Your OpenAPI file must be both:
- version 3
- in YAML format
Add the following to your
<OPENAPI_FILE>is your OpenAPI file, for example
Add the following in your documentation to convert the OpenAPI file into an API reference:
api_path you can also use:
- a relative path, for example
- an external file, for example
Convert a specific endpoint
You can convert a specific endpoint using the following in your documentation:
<ENDPOINT> is your endpoint, for example