Publicación de sitios de documentación

Publicar un sitio de documentación crea un espacio permanente y totalmente personalizado para su documentación de API, distinto de la función Quick Share, que está diseñada para la colaboración temporal. Mientras que Quick Share genera enlaces compartibles para una comunicación interna y externa rápida, Publish Docs Sites proporciona opciones de personalización completas, incluidos dominios personalizados, diseño de marca, control de navegación y funciones avanzadas. Esto lo hace ideal para crear documentación de API profesional y orientada al público que represente su marca.

Requisitos previos

Antes de publicar un sitio de documentación, asegúrese de tener:

Una cuenta de Apidog con un proyecto que contenga documentación de API

Permisos de administrador para el proyecto

(Opcional) Un dominio personalizado si planea usar URL con marca

Configuraciones preliminares

Publicar su sitio de documentación

Para publicar su sitio de documentación, vaya al módulo Publish Docs y haga clic en el sitio principal predeterminado; luego haga clic en el botón Publish.

Configuración de visibilidad del sitio de documentación

Requisito de versión

La versión de Apidog debe ser ≥ 2.7.15 para acceder a estas funciones de visibilidad.

Después de hacer clic en el botón Publish, puede controlar la visibilidad de su sitio de documentación publicado según sus requisitos de seguridad y acceso. Haga clic en el botón Publish right now para poner su sitio en línea con la configuración de visibilidad elegida.

Público

Sus sitios de documentación serán accesibles para todos los usuarios de Internet. También puede optar por publicar su documentación de API en API Hub, una plataforma operada por Apidog que ayuda a los usuarios a descubrir y explorar APIs.

Protegido con contraseña

Lista de permitidos de IP

Lista de permitidos de correo electrónico

Página de inicio de sesión personalizada

Alcance de publicación

De forma predeterminada, el alcance para publicar documentación se establece en todos los recursos Shared. Puede configurarlo en APIs. Para obtener más detalles, consulte la configuración de visibilidad.

Configuraciones avanzadas

Try It

Puede habilitar la función Try It para sus páginas de documentación, de modo que los usuarios puedan realizar peticiones de API directamente en la propia página de documentación.

Versiones de publicación

Puede crear y publicar varias versiones de su documentación de API. Obtenga más información sobre la publicación de versiones de API.

configuración de versiones para documentaciones de API.jpg

Recursos relacionados

¿Cómo pueden los usuarios de la documentación modificar la URL base en documentos compartidos?

¿Cómo compartir encabezados (por ejemplo, token) en Apidog Online Docs?

Configuración de dominio

Dominio proporcionado por Apidog: Su documento tendrá un subdominio predeterminado de Apidog, como https://vhh2uhkjv7.apidog.io. También puede modificarlo manualmente. Todos los documentos de Apidog utilizan el dominio apidog.io.

Dominio personalizado: Puede vincular el documento de Apidog a su propio dominio. Obtenga más información sobre el dominio personalizado.

configuración de dominio para documentaciones de API.jpg

Personalización visual

Puede personalizar la apariencia y los diseños de las documentaciones de API.

Puede previsualizar su documento en tiempo real aquí y guardarlo una vez que esté satisfecho con el resultado.

Apariencia

Diseño y navegación

Página de inicio personalizada

CSS, JavaScript y HTML personalizados

En Configuración de apariencia, puede configurar varias opciones básicas para su documentación de API, incluidas Title, Logo y Favicon.

En Display content, puede personalizar qué campos se muestran en la documentación de API, incluidos: Base URL, Maintainer y Last Modified Time.

Configuración de SEO

Configuración	Descripción
Metadatos globales	Configura los metadatos predeterminados para todo el sitio.
Archivo Robots	El archivo `robots.txt` indica a los motores de búsqueda qué páginas rastrear y mostrar en los resultados de búsqueda.
Archivo Sitemap	El archivo `sitemap.xml` proporciona a los motores de búsqueda una lista completa de todas las páginas de su sitio para una mejor indexación.
Reglas de redirección de documentos	Redirige a los usuarios a la página de documentación correcta cuando cambia una URL, evitando enlaces rotos.
Reglas de URL y slug	Define la estructura de URL y el formato de slug para sus páginas de documentación.

Configuración avanzada

Función	Descripción
Búsqueda en la documentación	Se integra con Algolia para proporcionar capacidades de búsqueda mejoradas para su documentación de API publicada. La función Ask AI desbloquea preguntas y respuestas conversacionales impulsadas por IA directamente dentro de la búsqueda de su documentación.
Proxy CORS	Especifica un proxy CORS para evitar problemas de origen cruzado que pueden surgir por las restricciones de seguridad del navegador.
Google Analytics	Habilita la integración con Google Analytics para rastrear y analizar el tráfico a su sitio de documentación.
Publicar en API Hub	Publica su documentación en API Hub, una plataforma abierta para compartir y descubrir APIs.
Descripción	Establece la descripción que se mostrará en API Hub si el proyecto se publica allí.
Permitir exportar y clonar datos	Permite a los usuarios exportar o clonar los datos de documentación desde la rama principal.

Publicar varios sitios de documentación

Para publicar documentos en distintos canales dentro del mismo proyecto, puede crear sitios de documentación adicionales durante la publicación. Para facilitar la gestión, puede duplicar la configuración del sitio principal para cada nuevo sitio. Cada subsitio también puede tener un nombre de dominio personalizado único.

Solo los subsitios le permiten establecer el alcance de visibilidad para los documentos publicados, lo que le permite elegir qué recursos son accesibles públicamente.

Publicación de sitios de documentación

Requisitos previos#

Configuraciones preliminares#

Publicar su sitio de documentación#

Configuración de visibilidad del sitio de documentación#

Alcance de publicación#

Configuraciones avanzadas#

Try It#

Versiones de publicación#

Configuración de dominio#

Personalización visual#

Configuración de SEO#

Configuración avanzada#

Publicar varios sitios de documentación#

Requisitos previos

Configuraciones preliminares

Publicar su sitio de documentación

Configuración de visibilidad del sitio de documentación

Alcance de publicación

Configuraciones avanzadas

Try It

Versiones de publicación

Configuración de dominio

Personalización visual

Configuración de SEO

Configuración avanzada

Publicar varios sitios de documentación