¡Pruébalo es la API!
La función ¡PRUÉBALO! le permite probar su API directamente en su navegador. Funciona tanto en un portal de documentación publicado como directamente dentro del editor.
Cómo configurarlo
La función ¡Pruébalo! utiliza la fetch API, por lo que para que funcione, sus importaciones de API deben tener lo siguiente:
- un URL de ruta absoluta a su API (no solo una ruta)
- agregue en su archivo .yml un URL como el siguiente
- servers:
- url example: https://petstore3.swagger.io/api/v3 (su URL real)
- los métodos de autorización se leerán desde su archivo de API y se incluirán en cada página de API
- CORS deshabilitado o habilitado para el dominio de documentación, de modo que los usuarios realmente puedan probar su API
Cómo funciona
Importe sus archivos API (importación directa o sincronización github)
[Opcional] Defina valores "predeterminado" en su archivo OpenAPI. De esta manera, cuando importe su API, todos los valores "default" se agregarán a la muestra de código y podrá probar su API inmediatamente sin necesidad de añadir manualmente valores a los parámetros.
Configure el método de API con los parámetros de prueba
Después de actualizar los parámetros, la muestra de código a la derecha (o debajo, dependiendo de cómo configure su vista) también se actualizará con los parámetros de prueba que añadió, proporcionándole el fragmento de código de la solicitud en varios lenguajes.
Presione el botón ¡Pruébalo! y revise el área de respuesta, debajo del código de ejemplo
