Configuration

Mintlify le permite definir sus endpoints de API utilizando una combinación de configuracióndocs.json, campos de metadatos MDX y el componente<ParamFields />. A partir de los endpoints definidos, generamos un área de juego de API, ejemplos de solicitudes y ejemplos de respuestas.

1. Configure su API

   En su archivodocs.json, defina su URL base y método de autenticación:

   "api": {
     "mdx": {
       "server": "https://mintlify.com/api", // string array for multiple base URLs
       "auth": {
         "method": "key",
         "name": "x-api-key" // options: bearer, basic, key.
       }
     }
   }

   Si no desea mostrar un área de juego de API, no necesita incluir tipos de autenticación. Oculte el área de juego con el siguiente campo:

   "api": {
     "playground": {
       "display": "none"
     }
   }

   Encuentre una lista completa de configuraciones de APIaquí.

2. Cree sus páginas de endpoints

   Cada página de endpoint de API debe tener un archivo MDX correspondiente. En la parte superior de cada archivo, defina:

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

   Puede especificar parámetros de ruta agregando el nombre del parámetro a la ruta, envuelto con{}:

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

   Si tieneserverconfigurado endocs.json, puede usar rutas relativas como/v1/endpoint.

   También puede anular el modo de visualización definido globalmente para el área de juego de API por página agregandoplaygrounden la parte superior del archivo MDX:

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

3. Agregue sus endpoints a su documentación

   Agregue sus páginas de endpoints a la barra lateral añadiendo las rutas al camponavigationen sudocs.json. Aprenda más sobre cómo estructurar su documentaciónaquí.