Descripción general

Apidog proporciona potentes capacidades de publicación que transforman sus especificaciones de API en documentación profesional e interactiva. Ya sea que necesite compartir API internamente con su equipo o publicar documentación completa de forma pública, Apidog ofrece opciones flexibles para satisfacer sus necesidades: desde enlaces de uso compartido rápido hasta sitios de documentación completamente personalizados con su propio dominio.

Comparta su documentación de API

Apidog ofrece varias formas de compartir y publicar su documentación de API, cada una diseñada para diferentes casos de uso:

Uso compartido rápido: Genere una documentación de API atractiva con un solo clic a partir de sus especificaciones de API definidas, ideal para una colaboración rápida

Documentación interactiva: Habilite la funcionalidad "Try it out" y la generación de código en línea para una exploración práctica de la API

Sitios de documentación: Publique sitios de documentación completos que combinen contenido en Markdown con documentación de API para crear guías de usuario completas

Navegación personalizada: Personalice la barra de navegación de su documento para mejorar la experiencia del usuario

Dominios personalizados: Vincule la documentación a su propio dominio para una imagen de marca profesional

URL personalizadas: Defina estructuras de URL de página personalizadas

Personalización de carpetas: Personalice los estilos de las carpetas y el comportamiento al hacer clic en su documentación

Publicación multiversión: Publique y gestione varias versiones de API simultáneamente

Documentación de ejemplo

Vea un ejemplo real de documentación publicada: https://docs.salla.dev/

Tecnologías de API compatibles

Apidog proporciona soporte completo para documentar prácticamente cualquier tecnología de API. Ya sea que trabaje con API REST tradicionales, GraphQL moderno, conexiones WebSocket en tiempo real o servicios SOAP empresariales, Apidog le ofrece cobertura.

Las tecnologías compatibles incluyen: REST, SOAP, GraphQL, gRPC, WebSocket, SSE y más.

Explore nuestra colección de mejores prácticas de documentación y ejemplos de API reales para ver cómo se pueden documentar eficazmente diferentes tipos de API.

Más información

Descubra guías detalladas y ejemplos para cada tecnología de API en Tecnologías de API compatibles.

Uso compartido rápido frente a publicación de documentación

Apidog ofrece dos métodos de publicación distintos, cada uno optimizado para diferentes escenarios. Comprender sus diferencias le ayudará a elegir el enfoque adecuado para sus necesidades.

Uso compartido rápido está diseñado para una colaboración rápida y flexible, ideal para compartir API específicas con miembros del equipo o socios externos durante el desarrollo. Publicar documentación está diseñado para crear sitios de documentación profesionales y orientados al público, con capacidades completas de personalización.

Comparación de funciones

Función	Uso compartido rápido	Publicar documentación
Publicar API parciales	✓ Compatible	Solo el proyecto completo
Dominio personalizado	✗ No compatible	✓ Compatible
Navegación personalizada	✗ No compatible	✓ Compatible
Colores y logotipo personalizados	✗ No compatible	✓ Compatible
Publicar en API Hub	✗ No compatible	✓ Compatible

Recomendación

Utilice Uso compartido rápido para la colaboración interna y revisiones rápidas de API. Utilice Publicar documentación cuando necesite un sitio de documentación profesional, con marca propia y destinado al público.

Comparta su documentación de API#

Tecnologías de API compatibles#

Uso compartido rápido frente a publicación de documentación#

Comparación de funciones#

Comparta su documentación de API

Tecnologías de API compatibles

Uso compartido rápido frente a publicación de documentación

Comparación de funciones