Launch Week III Day 5: OpenAPI Automations
![Hahnbee Lee](/blog/authors/hahnbee.jpg)
Hahnbee Lee
Co-founder
Launch Week Day 5 brings OpenAPI automations to your documentation 🤖.
When you're constantly shipping changes to your API, it's important to reflect those changes in your documentation ASAP.
Our revamped setup makes autogenerating your API Reference docs seamless, removing the need for any manual labor to reflect changes in production
![blog thumbnail](/blog/launch-week-3-day-5/thumbnail.png)
Getting Started
To auto-populate your API Playground pages, you can now add an openapi
field
to an object in the tabs
or anchors
arrays in
the mint.json
.
Example with Anchors:
{
"anchors": [
{
"name": "API Reference",
"openapi": "/path/to/openapi.json",
"url": "api-reference",
"icon": "square-terminal"
}
]
}
![blog thumbnail](/blog/launch-week-3-day-5/anchors.png)
Example with Tabs:
{
"tabs": [
{
"name": "API Reference",
"openapi": "/path/to/openapi.json",
"url": "api-reference"
}
]
}
![blog thumbnail](/blog/launch-week-3-day-5/tabs.png)
We also support this functionality for OpenAPI Specs hosted at a URL. For example:
{
"tabs": [
{
"name": "API Reference",
"url": "api-reference",
"openapi": "https://petstore3.swagger.io/api/v3/openapi.json"
}
]
}
Next Steps
Try out the feature yourself by updating your CLI:
npm i mintlify@latest -g
And adding the following code to your mint.json:
{
"tabs": [
{
"name": "API Reference",
"url": "api-reference",
"openapi": "https://petstore3.swagger.io/api/v3/openapi.json"
}
]
}
Thanks for tuning into Launch Week III!
Missed our previous launch days? Follow our Twitter/X or join our community to catch up on our exciting feature releases.