> ## 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.

# Playground

> Permite que las personas interactúen con tu API

<div id="overview">
  ## Descripción general
</div>

El área de pruebas de la API es un entorno interactivo que permite a los usuarios probar y explorar tus endpoints de API. Los desarrolladores pueden elaborar solicitudes a la API, enviarlas y ver las respuestas sin salir de tu documentación.

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/playground/API-playground-light.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=cbd122bacf76749c62b9515b60d55dcd" alt="Área de pruebas de la API para el endpoint que desencadena una actualización." className="block dark:hidden" width="2534" height="1022" data-path="images/playground/API-playground-light.png" />

  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/playground/API-playground-dark.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=b119dc4c0ce2427d76589461085e3a5d" alt="Área de pruebas de la API para el endpoint que desencadena una actualización." className="hidden dark:block" width="2534" height="1022" data-path="images/playground/API-playground-dark.png" />
</Frame>

El área de pruebas se genera automáticamente a partir de tu especificación de OpenAPI o del esquema de AsyncAPI, por lo que cualquier actualización de tu API se refleja automáticamente en el área de pruebas. También puedes crear manualmente páginas de referencia de la API después de definir una URL base y un método de Autenticación en tu `docs.json`.

Recomendamos generar tu área de pruebas de la API a partir de una especificación de OpenAPI. Consulta [OpenAPI Setup](/es/api-playground/openapi-setup) para obtener más información sobre cómo crear tu documento de OpenAPI.

<div id="getting-started">
  ## Primeros pasos
</div>

<Steps>
  <Step title="Agrega tu archivo de especificación de OpenAPI.">
    <Info>
      Asegúrate de que tu archivo de especificación de OpenAPI sea válido usando el [Swagger Editor](https://editor.swagger.io/) o la [CLI de Mint](https://www.npmjs.com/package/mint).
    </Info>

    ```bash {3} theme={null}
    /your-project
      |- docs.json
      |- openapi.json
    ```
  </Step>

  <Step title="Configura `docs.json`.">
    Actualiza tu `docs.json` para hacer referencia a tu especificación de OpenAPI. Agrega la propiedad `openapi` a cualquier elemento de navigation para autogenerar páginas en tu documentación para cada endpoint definido en tu documento de OpenAPI.

    Este ejemplo genera una página por cada endpoint definido en `openapi.json` y las organiza en el grupo "API reference" dentro de tu navigation.

    ```json theme={null}
    "navigation": {
      "groups": [
        {
          "group": "API reference",
          "openapi": "openapi.json"
        }
      ]
    }
    ```

    Para generar páginas solo para endpoints específicos, enuméralos en la propiedad `pages` del elemento de navigation.

    Este ejemplo genera páginas únicamente para los endpoints `GET /users` y `POST /users`. Para generar páginas de otros endpoints, agrega más endpoints al arreglo `pages`.

    ```json theme={null}
    "navigation": {
      "groups": [
          {
            "group": "API reference",
            "openapi": "openapi.json",
            "pages": [
              "GET /users",
              "POST /users"
            ]
          }
      ]
    }
    ```
  </Step>
</Steps>

<div id="customizing-your-playground">
  ## Personalización del área de pruebas
</div>

Puedes personalizar tu área de pruebas de la API definiendo las siguientes propiedades en tu `docs.json`.

<ResponseField name="playground" type="object">
  Configuraciones del área de pruebas de la API.

  <Expandable title="playground" defaultOpen="True">
    <ResponseField name="display" type="&#x22;interactive&#x22; | &#x22;simple&#x22; | &#x22;none&#x22;">
      El modo de visualización del área de pruebas de la API.

      * `"interactive"`: Muestra el área de pruebas interactiva.
      * `"simple"`: Muestra un endpoint que se puede copiar, sin área de pruebas.
      * `"none"`: No muestra nada.

      El valor predeterminado es `interactive`.
    </ResponseField>

    <ResponseField name="proxy" type="boolean" defaultOpen="True">
      Indica si se deben enviar las solicitudes de la API a través de un servidor proxy. De manera predeterminada es `true`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="examples" type="object">
  Configuraciones para los ejemplos de API generados automáticamente.

  <Expandable title="examples" defaultOpen="True">
    <ResponseField name="languages" type="array of string">
      Idiomas para los fragmentos de API generados automáticamente.

      Los idiomas se muestran en el orden especificado.
    </ResponseField>

    <ResponseField name="defaults" type="&#x22;required&#x22; | &#x22;all&#x22;">
      Indica si se deben mostrar los parámetros opcionales en los ejemplos de la API. De manera predeterminada es `all`.
    </ResponseField>
  </Expandable>
</ResponseField>

<div id="example-configuration">
  ### Ejemplo de configuración
</div>

```json theme={null}
{
 "api": {
   "playground": {
     "display": "interactive"
   },
   "examples": {
     "languages": ["curl", "python", "javascript"],
     "defaults": "required"
   }
 }
}
```

Este ejemplo configura el área de pruebas de la API para que sea interactiva, con fragmentos de código de ejemplo para cURL, Python y JavaScript. Solo se muestran los parámetros obligatorios en los fragmentos de código.

<div id="custom-endpoint-pages">
  ### Páginas de endpoints personalizadas
</div>

Cuando necesites más control sobre tu documentación de API, usa la extensión `x-mint` en tu especificación de OpenAPI o crea páginas `MDX` individuales para tus endpoints.

Ambas opciones te permiten:

* Personalizar los metadatos de la página
* Añadir contenido adicional, como ejemplos
* Controlar el comportamiento del playground por página

Se recomienda la extensión `x-mint` para que toda tu documentación de API se genere automáticamente a partir de tu especificación de OpenAPI y se mantenga en un solo archivo.

Se recomiendan las páginas `MDX` individuales para APIs pequeñas o cuando quieras probar cambios por página.

Para más información, consulta [Extensión x-mint](/es/api-playground/openapi-setup#x-mint-extension) y [Configuración de MDX](/es/api-playground/mdx/configuration).

<div id="further-reading">
  ## Lecturas adicionales
</div>

* [Configuración de AsyncAPI](/es/api-playground/asyncapi/setup) para obtener más información sobre cómo crear tu esquema de AsyncAPI y generar páginas de referencia de WebSocket.