Ver documentos API en diferentes modos

APIGit

2022-11-15

APIGit ofrece una experiencia flexible y fácil de usar para ver documentos API. Puede cambiar fácilmente entre diferentes visores para ver el mismo documento desde diferentes perspectivas, lo que le permite obtener una comprensión más profunda de la API y sus capacidades. El visor predeterminado se crea utilizando el popular visor Redoc de código abierto, que proporciona un diseño atractivo y sencillo que facilita la navegación y la comprensión de la documentación de la API.

API main

El visor Swagger es una opción clásica y fácil de usar para visualizar documentos API. Ofrece un diseño simple y ordenado que permite una navegación clara y eficiente. Además, este visor está optimizado para el rendimiento, lo que lo convierte en una opción ideal para documentos API grandes o complejos. Proporciona una forma tradicional de comprender y navegar por la documentación de la API, que es simple y fácil de entender.

swagger UI

El visor de código ofrece una vista sin formato y sin formato de un documento API, lo que proporciona a los usuarios una visión detallada de la estructura subyacente y el formato del documento. Este visor es particularmente útil para depurar errores, ya que permite a los usuarios ver el código exacto y el formato utilizado en la API. Además, para los expertos en desarrollo de API, el visor de código puede ser una forma eficiente de editar documentos de API, proporcionando un fácil acceso al código subyacente. Este visor es la mejor opción para desarrolladores y expertos que desean comprender la documentación de la API de una manera más técnica y realizar cambios en ella.

Code viewer

El visor de diferencias permite a los usuarios comparar dos documentos API diferentes dentro de un repositorio. Esta función es particularmente útil para las integraciones de terceros, ya que permite una fácil revisión y comprensión de los cambios realizados en los documentos API generados automáticamente. Ayuda a comparar los cambios realizados en el documento de la API y comprender mejor las actualizaciones. Es una gran herramienta para revisar actualizaciones, fusionar cambios y garantizar la coherencia en los documentos de la API.

diff viewer