Producto
Documento API
APIGit ofrece documentos de API bellamente temáticos y fáciles de usar con varios modos de vista. Puede publicar un documento de API desde cualquier punto del historial del repositorio de API, lo que garantiza que siempre tenga acceso a la última versión de su documentación. Además, también puede apuntar su propio dominio a los documentos publicados, lo que le permite presentarlos con el estilo de su marca. Facilita compartir la documentación de su API con equipos internos y socios externos, al mismo tiempo que mantiene una apariencia uniforme y profesional.
Documentos API elegantes y claros
Un documento de API publicado se compone de dos componentes: especificaciones de API y documentos de descuento, los cuales se obtienen de los archivos del repositorio de API. Puede publicar varios documentos API como versiones diferentes y cambiar fácilmente entre ellos.
Modo de visualización de las especificaciones de la API: predeterminado
Los documentos de especificación de API se pueden ver en diferentes modos, lo que brinda una comprensión integral de la API. Los modos admitidos incluyen: la vista predeterminada, la interfaz de usuario swagger y el modo de código sin procesar. Esto le permite ver e interactuar con la documentación de la API de la forma que mejor se adapte a sus necesidades.
Modo de visualización de las especificaciones de la API: modo de interfaz de usuario swagger
En el modo de interfaz de usuario de Swagger, puede ver la documentación de la API en el tema tradicional de Swagger, lo que proporciona una interfaz familiar y fácil de usar para comprender e interactuar con la API.
Modo de visualización de las especificaciones de la API: modo de código
En el modo de código, puede ver los archivos de especificación API sin procesar, lo que brinda acceso directo al código subyacente, lo que facilita la revisión y la realización de cambios si es necesario.
Documentos rebajados
Los documentos Markdown también se incluyen en los documentos API publicados. Proporcionan una ubicación ideal para presentar sus conceptos de diseño y la lógica comercial detrás de las API. Además, también admitimos el modo predeterminado y de código para documentos de descuento, lo que le permite ver y revisar los documentos de la manera que mejor se adapte a sus necesidades.
Dominio personalizado
Una vez que configura un dominio personalizado, puede usar un registro CNAME para apuntar su propio dominio a sus documentos publicados, lo que le permite mostrarlos con su propia marca y URL.
© 2024 APIGit Inc.