¡Prueba la API!
La ¡PRUÉBALO! permite probar tu API directamente en tu navegador. Funciona tanto en un portal de documentación publicado como directamente dentro del editor.
Cómo configurar
La ¡Pruébalo! usa la API fetch, así que para que funcione, tus imports de API deben tener lo siguiente:
- una URL de ruta absoluta a tu API (no solo una ruta)
- agrega en tu archivo .yml una URL como la siguiente
- servidores:
- ejemplo de url: https://petstore3.swagger.io/api/v3 (tu URL real)
- los métodos de autorización serán leídos desde tu archivo api y se incluirán en cada página de API
- CORS deshabilitado o habilitado para el dominio de la documentación, para que los usuarios puedan realmente probar tu API
Cómo funciona
Importa tus archivos API (importación directa o sincronización con GitHub)
[Opcional] Define "predeterminado" valores en tu archivo OpenAPI. De esta manera, cuando importes tu API, todos los valores "predeterminados" se agregarán al ejemplo de código, y podrás probar tu API inmediatamente sin necesidad de agregar manualmente valores a los parámetros.
Configura el método API con los parámetros de prueba
Después de actualizar los parámetros, el ejemplo de código a la derecha (o abajo, dependiendo de cómo configures tu vista) también se actualizará con los parámetros de prueba que agregaste, proporcionándote el fragmento de código de la solicitud en varios idiomas.
Pulsa el botón ¡Pruébalo! y revisa el área de respuesta debajo del ejemplo de código
