​
Getting Started with OpenAPI

To use OpenAPI in your Mintlify documentation, you’ll need to focus on two main components:

  1. Base URL Configuration
  • Add a servers field to specify your API’s base URL
  • This enables the API Playground feature
  • Without a server URL, the API Playground will run in simple mode
  1. Authentication Setup
  • Define your authentication methods using securitySchemes
  • Common types include Basic, Bearer, and API Keys
  • Apply authentication using the security field

For detailed OpenAPI syntax and examples, we recommend using Swagger’s Editor and referring to the OpenAPI v3.1.0 Specification.

​
Getting Started with OpenAPI

To use OpenAPI in your Mintlify documentation, you’ll need to focus on two main components:

  1. Base URL Configuration
  • Add a servers field to specify your API’s base URL
  • This enables the API Playground feature
  • Without a server URL, the API Playground will run in simple mode
  1. Authentication Setup
  • Define your authentication methods using securitySchemes
  • Common types include Basic, Bearer, and API Keys
  • Apply authentication using the security field

For detailed OpenAPI syntax and examples, we recommend using Swagger’s Editor and referring to the OpenAPI v3.1.0 Specification.