Skip to content

Document localhost OpenAPI previews #7156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hamedrabah wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document localhost OpenAPI previews #7156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions api-playground/openapi-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,29 @@ Reference any number of OpenAPI specifications in the navigation element of your
Mintlify supports `$ref` for **internal references only** within a single OpenAPI document. Mintlify does not support external references.
</Note>

### Use a localhost specification

During local development, you can generate an OpenAPI document from a service running on your machine and reference its localhost URL:

```json
"navigation": {
"tabs": [
{
"tab": "API Reference",
"openapi": "http://localhost:8000/openapi.json"
}
]
}
```

Pass `--local-schema` to allow the CLI to fetch the specification over HTTP:

```bash
mint dev --local-schema
```

To validate the same configuration without starting a preview, run `mint validate --local-schema`. Production deployments require OpenAPI URLs to use HTTPS.

### Describe your API

Use the following resources to learn about and construct your OpenAPI specification.
Expand Down