mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
baa1f6bd96
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
211 lines
9.0 KiB
Plaintext
211 lines
9.0 KiB
Plaintext
---
|
|
title: "Playground"
|
|
description: "Permite que los desarrolladores prueben endpoints de la API directamente en tu documentación."
|
|
keywords: ["interactivo", "API", "pruebas de endpoints", "solicitudes en vivo a la API", "generador de solicitudes"]
|
|
---
|
|
|
|
<div id="overview">
|
|
## Descripción general
|
|
</div>
|
|
|
|
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](/es/api/update/trigger) para ver un ejemplo del playground de API en acción.
|
|
|
|
<Frame>
|
|
<img src="/images/playground/API-playground-light.png" alt="Playground de API para el endpoint Trigger an update." className="block dark:hidden" />
|
|
|
|
<img src="/images/playground/API-playground-dark.png" alt="Playground de API para el endpoint Trigger an update." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
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`.
|
|
|
|
<div id="get-started">
|
|
## Primeros pasos
|
|
</div>
|
|
|
|
<Steps>
|
|
<Step title="Añade tu archivo de especificación de OpenAPI.">
|
|
<Tip>
|
|
Valida tu archivo de especificación de OpenAPI con el [Swagger Editor](https://editor.swagger.io/) o con el comando de la [Mint CLI](https://www.npmjs.com/package/mint) `mint openapi-check <filename>`.
|
|
</Tip>
|
|
|
|
```bash {3}
|
|
/your-project
|
|
|- docs.json
|
|
|- openapi.json
|
|
```
|
|
</Step>
|
|
|
|
<Step title="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".
|
|
|
|
```json 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`.
|
|
|
|
```json Generate specific endpoint pages
|
|
"navigation": {
|
|
"groups": [
|
|
{
|
|
"group": "API reference",
|
|
"openapi": "openapi.json",
|
|
"pages": [
|
|
"GET /users",
|
|
"POST /users"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
<div id="customize-your-playground">
|
|
## Personaliza tu playground
|
|
</div>
|
|
|
|
Personaliza tu playground de API definiendo las siguientes propiedades en tu `docs.json`.
|
|
|
|
<ResponseField name="playground" type="object">
|
|
Configuraciones del playground de API.
|
|
|
|
<Expandable title="playground" defaultOpen="True">
|
|
<ResponseField name="display" type=""interactive" | "simple" | "none" | "auth"">
|
|
El modo de visualización del playground de API.
|
|
|
|
* `"interactive"`: Muestra el playground interactivo.
|
|
* `"simple"`: Muestra un endpoint copiables sin playground.
|
|
* `"none"`: No muestra nada.
|
|
* `"auth"`: Muestra el playground interactivo solo para usuarios autenticados. Los usuarios no autenticados o que no pertenecen a los groups requeridos no ven ningún playground.
|
|
|
|
Valor predeterminado: `interactive`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="proxy" type="boolean" defaultOpen="True">
|
|
Indica si las solicitudes de API deben pasar por un servidor proxy. Valor predeterminado: `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">
|
|
Lenguajes para los fragmentos de API generados automáticamente.
|
|
|
|
Se muestran en el orden especificado.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="defaults" type=""required" | "all"">
|
|
Indica si se muestran los parámetros opcionales en los ejemplos de API. Valor predeterminado: `all`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="prefill" type="boolean">
|
|
Indica si se debe prellenar el playground de API con datos de ejemplos del esquema. Cuando está habilitado, el playground completa automáticamente los campos de la solicitud con valores de ejemplo de tu especificación OpenAPI. Valor predeterminado: `false`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="autogenerate" type="boolean">
|
|
Indica si se deben generar muestras de código para los endpoints a partir de las especificaciones de API. Valor predeterminado: `true`. Cuando se establece en `false`, solo aparecen en el playground de API las muestras de código escritas manualmente (a partir de `x-codeSamples` en las especificaciones OpenAPI o de componentes `<RequestExample>` en MDX).
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<div id="example-configuration">
|
|
### Configuración de ejemplo
|
|
</div>
|
|
|
|
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.
|
|
|
|
```json
|
|
{
|
|
"api": {
|
|
"playground": {
|
|
"display": "interactive"
|
|
},
|
|
"examples": {
|
|
"languages": ["curl", "python", "javascript"],
|
|
"defaults": "required",
|
|
"prefill": true
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
<div id="auth-based-playground-display">
|
|
### Visualización del playground basada en la autenticación
|
|
</div>
|
|
|
|
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.
|
|
|
|
```mdx 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.
|
|
|
|
<Note>
|
|
El modo de visualización `auth` requiere que la [autenticación](/es/deploy/authentication-setup) esté configurada para tu documentación.
|
|
</Note>
|
|
|
|
<div id="custom-endpoint-pages">
|
|
### Páginas de endpoints personalizadas
|
|
</div>
|
|
|
|
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.
|
|
|
|
<div id="further-reading">
|
|
## Lecturas adicionales
|
|
</div>
|
|
|
|
* [Configuración de OpenAPI](/es/api-playground/openapi-setup) para obtener más información sobre cómo crear tu documento OpenAPI.
|
|
* [Extensión x-mint](/es/api-playground/openapi-setup#x-mint-extension) para obtener más información sobre cómo personalizar las páginas de tus endpoints.
|
|
* [Configuración de MDX](/es/api-playground/mdx-setup) para obtener más información sobre cómo crear manualmente páginas individuales de referencia de tu API.
|
|
* [Configuración de AsyncAPI](/es/api-playground/asyncapi-setup) para obtener más información sobre cómo crear tu esquema AsyncAPI para generar páginas de referencia de WebSocket. |