API Playground
Reduzca el tiempo de desarrollo y permita que sus lectores prueben sus API directamente desde la referencia de la API con un API Playground.

Con el API Playground, todos los encabezados, parámetros de consulta, datos de formulario y campos del cuerpo de la solicitud se rellenan previamente con los ejemplos que usted proporciona en la especificación OpenAPI. Los lectores pueden modificar los campos y realizar una solicitud a la API directamente desde la referencia de la API. Los encabezados y parámetros se validan según su tipo, y se muestran las enumeraciones si están disponibles. Los usuarios pueden iniciar flujos de OAuth 2.0 directamente desde la referencia de la API para obtener tokens de acceso.
Se mostrará la respuesta de la solicitud a la API, junto con el código de estado. Los lectores pueden pasar el cursor sobre el código de estado para ver los encabezados de la respuesta.
Requisitos previos para habilitar el API Playground
Antes de habilitar el API Playground, debe realizar dos configuraciones externas:
Configure los encabezados CORS para el dominio de su documentación. Todas las solicitudes se realizan directamente desde el navegador, por lo que debe configurar los encabezados CORS para permitir que el dominio de la documentación haga solicitudes a su API. Los encabezados CORS deben permitir que el origen del sitio de documentación realice cualquier solicitud HTTP, con todos los encabezados que pueda enviar, y exponer todos los encabezados devueltos. La respuesta con los encabezados CORS debería verse así:
(Opcional) Configure su cliente OAuth2 para redirigir a nuestra URL de redirección. Si su API usa OAuth2 y desea que el lector pueda generar un token directamente desde el API Playground, debe agregar nuestra URL de redirección a su cliente OAuth2. Consulte Autenticación OAuth 2.0.
Habilitar el API Playground
Para habilitar el API Playground en una referencia de API, abra Manage Sections, seleccione la referencia de la API y active Show API Playground en la tarjeta API Playground.
Compatibilidad del API Playground
El API Playground es compatible con todas las operaciones de la API excepto:
Respuestas que no tienen un tipo de medio JSON o texto plano.
Solicitudes que suben archivos.
Todas las solicitudes se realizan directamente desde el navegador, por lo que debe asegurarse de que la API devuelva los encabezados CORS correctos para el dominio de su documentación.
Personalización de los valores de autenticación
Para personalizar los valores de autenticación, como los del encabezado y la cadena de consulta, contáctenos.
Autenticación OAuth 2.0
Para permitir la autenticación OAuth 2.0 dentro del API Playground, debe agregar la siguiente URL de redirección a la configuración de su cliente OAuth 2.0:
https://<docs-site>/$reader-oauth2
Por ejemplo:
https://docs.developerhub.io/$reader-oauth2.
Una vez configurado, puede habilitar la autenticación OAuth 2.0 activando OAuth2 authentication en la misma tarjeta del API Playground. Solo se aplica mientras se muestra el API Playground.

Si desea permitir también la autenticación OAuth 2.0 en el editor, debe agregar la siguiente URL de redirección: https://app.developerhub.io/$reader-oauth2. Sin embargo, esta no debe usarse en una API de producción.
Interceptores personalizados
Los interceptores personalizados le permiten modificar una solicitud antes de enviarla. Esto puede ser útil si, por ejemplo, necesita agregar firmas digitales. Los interceptores personalizados son middleware escrito en JavaScript.
¿Cómo configurar interceptores personalizados?
Para configurar interceptores personalizados:
Agregue un script que registre cada interceptor personalizado necesario usando la función
window.registerCustomInterceptor.
Función: registerCustomInterceptor.
Devuelve: nada.
Argumentos: Function - function(data, next). Donde data tiene la siguiente definición:
Y next es una función que debe llamarse una vez por cada interceptor personalizado, proporcionando como argumento los datos modificados, para pasarlos al siguiente interceptor personalizado.
Ejemplos de interceptores personalizados
No tiene efecto. Solo registra los datos:
Agrega un nuevo encabezado:
Modifica los datos del formulario:
Modifica el cuerpo JSON solo en una determinada referencia de API:
Solución de problemas
La solicitud falla
Si la solicitud falla con el mensaje "Request failed (Unknown Error)" y estado 0, asegúrese de que los encabezados CORS estén configurados correctamente. Puede confirmar que este es el problema revisando las DevTools de su navegador. Un error así se mostraría en las DevTools de Chrome: Access to XMLHttpRequest at '<url>' from origin '<url>' has been blocked by CORS policy: Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource.
Sin encabezados de respuesta
Si no se envían los encabezados de respuesta, asegúrese de que su API devuelva el encabezado Access-Control-Expose-Headers: *, que permite al navegador leer los encabezados de la respuesta.
Need help? Visit our community forums or contact us.