Saltar al contenido principal

​
Descripción general

El playground de API es un entorno interactivo que permite a los usuarios probar y explorar tus endpoints de API. Los desarrolladores pueden crear solicitudes de API, enviarlas y ver las respuestas sin salir de tu documentación. Consulta Trigger an update para ver un ejemplo del playground de API en acción.
Playground de API para el endpoint Trigger an update.
El playground genera páginas interactivas para tus endpoints a partir de tu especificación OpenAPI o esquema AsyncAPI. Si modificas tu API, el playground actualiza automáticamente las páginas correspondientes. Recomendamos generar tu playground de API a partir de una especificación OpenAPI. Sin embargo, puedes crear manualmente páginas de referencia de API después de definir una URL base y un método de autenticación en tu docs.json.

​
Primeros pasos

1

Añade tu archivo de especificación de OpenAPI.

Valida tu archivo de especificación de OpenAPI con el Swagger Editor o con el comando de la Mint CLI mint openapi-check <filename>.
/your-project
  |- docs.json
  |- openapi.json
2

Genera páginas de endpoints.

Actualiza tu docs.json para hacer referencia a tu especificación de OpenAPI.Para generar automáticamente páginas para todos los endpoints de tu especificación de OpenAPI, añade una propiedad openapi a cualquier elemento de navegación.Este ejemplo genera una página para cada endpoint definido en openapi.json y organiza las páginas en el grupo “API reference”.
Generate all endpoint pages
"navigation": {
  "groups": [
    {
      "group": "API reference",
      "openapi": "openapi.json"
    }
  ]
}
Para generar páginas solo para endpoints específicos, enumera los endpoints en la propiedad pages del elemento de navegación.Este ejemplo genera páginas únicamente para los endpoints GET /users y POST /users. Para generar otras páginas de endpoints, añade más endpoints al arreglo pages.
Generate specific endpoint pages
"navigation": {
  "groups": [
      {
        "group": "API reference",
        "openapi": "openapi.json",
        "pages": [
          "GET /users",
          "POST /users"
        ]
      }
  ]
}

​
Personaliza tu playground

Personaliza tu playground de API definiendo las siguientes propiedades en tu docs.json.
​
playground
object
Configuraciones del playground de API.
​
examples
object
Configuraciones para los ejemplos de API generados automáticamente.

​
Configuración de ejemplo

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. En los fragmentos solo se muestran los parámetros obligatorios, y el área de pruebas rellena el cuerpo de la solicitud con valores de ejemplo. 
{
 "api": {
   "playground": {
     "display": "interactive"
   },
   "examples": {
     "languages": ["curl", "python", "javascript"],
     "defaults": "required",
     "prefill": true
   }
 }
}

​
Visualización del playground basada en la autenticación

Usa el modo de visualización auth para mostrar el playground interactivo solo a usuarios autenticados. Esto es útil cuando quieres que los usuarios puedan consultar públicamente la documentación de tu API mientras restringes el acceso al playground a los usuarios que han iniciado sesión. Cuando display está configurado en auth:
  • Los usuarios autenticados ven el playground interactivo.
  • Los usuarios no autenticados no ven ningún playground (equivalente a none).
También puedes combinar auth con la propiedad groups en el frontmatter de la página para restringir el acceso al playground a grupos de usuarios específicos.
Page with group-restricted playground
---
title: "Crear usuario"
openapi: POST /users
playground: auth
groups: ["admin", "developer"]
public: true
---
En este ejemplo:
  • La página es públicamente visible (cualquiera puede ver la documentación).
  • Solo los usuarios autenticados que pertenecen a los grupos admin o developer ven el playground interactivo.
  • Los usuarios que no están en esos grupos no ven ningún playground.
Si la página no tiene la propiedad groups, todos los usuarios autenticados pueden ver el playground interactivo.
El modo de visualización auth requiere que la autenticación esté configurada para tu documentación.

​
Páginas de endpoints personalizadas

Cuando necesites más control sobre la documentación de tu API, usa la extensión x-mint en tu especificación OpenAPI o crea páginas MDX individuales para tus endpoints. Ambas opciones te permiten:
  • Personalizar el metadata de la página
  • Agregar contenido adicional, como ejemplos
  • Controlar el comportamiento del playground por página
Se recomienda la extensión x-mint para que toda la documentación de tu API se genere automáticamente a partir de tu especificación OpenAPI y se mantenga en un solo archivo. Las páginas MDX individuales se recomiendan para APIs pequeñas o cuando quieras experimentar con cambios página por página.

​
Lecturas adicionales

  • Configuración de OpenAPI para obtener más información sobre cómo crear tu documento OpenAPI.
  • Extensión x-mint para obtener más información sobre cómo personalizar las páginas de tus endpoints.
  • Configuración de MDX para obtener más información sobre cómo crear manualmente páginas individuales de referencia de tu API.
  • Configuración de AsyncAPI para obtener más información sobre cómo crear tu esquema AsyncAPI para generar páginas de referencia de WebSocket.