Swagger es un conjunto de herramientas open source para documentar, diseñar y probar APIs REST. La especificación OpenAPI (antes Swagger) es el estándar de descripción de APIs más utilizado en el mundo.
¿Qué es Swagger?
Swagger es un ecosistema de herramientas para el diseño, documentación y prueba de APIs REST. La especificación OpenAPI (que inicialmente se llamaba Swagger Specification) se ha convertido en el estándar mundial para describir APIs RESTful de forma legible por máquinas y humanos.
Componentes de Swagger
- Swagger UI: Interfaz web interactiva para explorar y probar los endpoints de una API
- Swagger Editor: Editor en línea para escribir especificaciones OpenAPI en YAML/JSON
- Swagger Codegen: Generador automático de SDK clientes en más de 40 lenguajes
Ventajas de Swagger/OpenAPI
- Documentación viva: La documentación siempre está sincronizada con la API real
- Pruebas interactivas: Pruebe cada endpoint directamente desde el navegador
- Generación de código: SDKs clientes generados automáticamente
Swagger en AILabsAudit
AILabsAudit proporciona documentación Swagger interactiva accesible en /api/v1/docs. Puede explorar todos los endpoints, ver los esquemas de petición/respuesta y probar las llamadas directamente con su clave API.