MDX Setup

Generate API documentation with MDX

Mintlify helps you create interactive API documentation using MDX files and the mint.json configuration. This setup enables API playground functionality, request examples, and response examples.

1. Configure API settings

   Add your API configuration to mint.json:

   {
     "api": {
       "baseUrl": "https://mintlify.com/api",
       "auth": {
         "method": "bearer"
       }
     }
   }
   

   To hide the API playground, use:

   {
     "api": {
       "playground": {
         "mode": "hide"
       }
     }
   }
   

   See all API configuration options in our reference guide.

2. Create endpoint pages

   For each endpoint, create an MDX file with the following frontmatter:

   ---
   title: 'Create new user'
   api: 'POST https://api.mintlify.com/user'
   ---
   

   Use {parameterName} for path parameters:

   https://api.example.com/v1/users/{userId}
   

   With baseUrl configured, you can use relative paths like /v1/users

3. Add to navigation

   Add your endpoint pages to the navigation field in mint.json. Learn more about navigation here.