> ## Documentation Index
> Fetch the complete documentation index at: https://omer-914cc1c6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuración de MDX

> Genera páginas de documentación para tus endpoints de API usando `MDX`

Puedes definir manualmente endpoints de API en archivos `MDX` individuales en lugar de usar una especificación OpenAPI. Este método ofrece flexibilidad para contenido personalizado, pero recomendamos generar la documentación de la API a partir de un archivo de especificación OpenAPI para la mayoría de los proyectos, ya que es más fácil de mantener y más completo en funcionalidades. Aun así, crear páginas `MDX` para una API puede ser útil para documentar APIs pequeñas o para hacer prototipos.

Para generar páginas para endpoints de API usando `MDX`, configura tu API en `docs.json`, crea archivos `MDX` individuales para cada endpoint y usa componentes como `<ParamFields />` para definir parámetros. A partir de estas definiciones, Mintlify genera áreas de pruebas de la API interactivas, ejemplos de solicitudes y ejemplos de respuestas.

<Steps>
  <Step title="Configura tu API">
    En tu archivo `docs.json`, define tu URL base y el método de autenticación:

    ```json theme={null}
     "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 deseas ocultar el área de pruebas de la API, usa el campo `display`. No necesitas incluir un método de autenticación si ocultas el área de pruebas.

    ```json theme={null}
    "api": {
      "playground": {
        "display": "none"
      }
    }
    ```

    Consulta la lista completa de configuraciones de la API en [Settings](/es/settings#api-configurations).
  </Step>

  <Step title="Crea las páginas de tus endpoints">
    Cada endpoint de la API debe tener un archivo `MDX` correspondiente. En la parte superior de cada archivo, define `title` y `api`:

    ```mdx theme={null}
    ---
    title: 'Create new user'
    api: 'POST https://api.mintlify.com/user'
    ---
    ```

    Puedes especificar parámetros de ruta agregando el nombre del parámetro en la ruta, entre `{}`:

    ```bash theme={null}
    https://api.example.com/v1/endpoint/{userId}
    ```

    <Note>
      Si tienes un campo `server` configurado en `docs.json`, puedes usar rutas relativas como `/v1/endpoint`.
    </Note>

    Puedes sustituir el modo de visualización definido globalmente para el área de pruebas de la API en una página agregando `playground` al frontmatter:

    ```mdx theme={null}
    ---
    title: 'Create new user'
    api: 'POST https://api.mintlify.com/user'
    playground: 'none'
    ---
    ```

    * `playground: 'interactive'` - Muestra el área de pruebas interactiva.
    * `playground: 'simple'` - Muestra un endpoint copiable sin área de pruebas.
    * `playground: 'none'` - Oculta el área de pruebas.
  </Step>

  <Step title="Agrega tus endpoints a tu documentación">
    Agrega las páginas de tus endpoints a la barra lateral añadiendo las rutas en el campo `navigation` de tu `docs.json`. Obtén más información sobre cómo estructurar tu documentación en [Navigation](/es/navigation).
  </Step>
</Steps>

<div id="enabling-authentication">
  ## Habilitar la autenticación
</div>

Puedes añadir un método de autenticación en tu `docs.json` para habilitarla globalmente en todas las páginas, o configurarlo de forma individual por página.

El método de autenticación definido en una página reemplazará el método global si ambos están configurados.

<div id="bearer-token">
  ### Token de portador (Bearer)
</div>

<CodeGroup>
  ```json docs.json theme={null}
  "api": {
      "mdx": {
        "auth": {
          "method": "bearer"
        }
      }
  }
  ```

  ```mdx Page Metadata theme={null}
  ---
  title: "Your page title"
  authMethod: "bearer"
  ---
  ```
</CodeGroup>

<div id="basic-authentication">
  ### Autenticación básica
</div>

<CodeGroup>
  ```json docs.json theme={null}
  "api": {
      "mdx": {
        "auth": {
          "method": "basic"
        }
      }
  }
  ```

  ```mdx Page Metadata theme={null}
  ---
  title: "Your page title"
  authMethod: "basic"
  ---
  ```
</CodeGroup>

<div id="api-key">
  ### Clave de API
</div>

<CodeGroup>
  ```json docs.json theme={null}
  "api": {
      "mdx": {
        "auth": {
          "method": "key",
          "name": "x-api-key"
        }
      }
  }
  ```

  ```mdx Page Metadata theme={null}
  ---
  title: "Your page title"
  authMethod: "key"
  ---
  ```
</CodeGroup>

<div id="none">
  ### Ninguno
</div>

El método de autenticación `none` es útil para desactivar la autenticación en un endpoint específico después de establecer un valor predeterminado en docs.json.

<CodeGroup>
  ```mdx Page Metadata theme={null}
  ---
  title: "Your page title"
  authMethod: "none"
  ---
  ```
</CodeGroup>