Para que la API sea fácil de entender, implementar y mantener, la documentación de calidad es importante. Configuramos la generación automática de documentación basada en especificaciones OpenAPI con Swagger UI y Redoc, dos de las herramientas de visualización de API más populares.
Esto le permite proporcionar a los desarrolladores una interfaz interactiva donde explorar la estructura de los métodos, probar consultas y conectarse rápidamente a su API.
Qué se incluye en la documentación
| Sección | Descripción |
|---|---|
| Endpoint's y métodos | Lista completa de rutas, métodos HTTP, opciones, encabezados |
| Ejemplos de consultas/respuestas | Scripts para curl, Postman, JavaScript, Python y otros idiomas |
| Autorización | Soporte para JWT, OAuth2, API clave directamente desde la interfaz |
| Diagramas de objetos | Descripción de modelos, estructuras anidadas y requisitos de datos |
| Códigos de error | Todos los estados posibles con explicaciones |
Las herramientas que utilizamos
Swagger UI - Documentación interactiva en el navegador, con capacidad de prueba
Redoc es una interfaz legible y estática, ideal para su publicación en el sitio web
OpenAPI 3. 0/3. 1 es el formato de especificación en base al cual se construye todo
Autogeneración de código: anotaciones, descripciones, versiones y actualizaciones de documentación automáticamente
Exportación a JSON/YAML/HTML
Beneficios para el equipo y los socios
Aceleración del onboarding de nuevos desarrolladores
Reducción del número de errores de integración
Documentación siempre actualizada y sincronizada con el código
Inicio rápido de la integración sin asistencia técnica
Fácil publicación de documentación en portales públicos o privados
Donde es especialmente importante
API abiertas para desarrolladores externos
API internas con desarrollo activo
Plataformas con integraciones B2B y SDK
Servicios con requisitos de regulación y validación de circuitos
Swagger y Redoc son el estándar de documentación API de nueva generación. Configuraremos la generación, actualización y publicación de la documentación para que cualquier desarrollador pueda comenzar a integrarse con su API en cuestión de minutos.