Uso compartido rápido

La colaboración eficaz en API requiere compartir documentación sin fricciones. Uso compartido rápido elimina la ineficiencia de enviar archivos Word o PDF al proporcionar enlaces instantáneos de documentación en línea. Esta función permite una comunicación rápida entre equipos, lo que le permite compartir endpoints de API específicos con colaboradores mientras mantiene el control sobre el acceso, la visibilidad y la caducidad.

Requisitos previos

Antes de crear un Uso compartido rápido, asegúrese de tener:

Una cuenta de Apidog con acceso a un proyecto

Endpoints de API o documentación para compartir

(Opcional) Entornos configurados si desea que los lectores prueben endpoints

Crear un Uso compartido rápido

Cambie al módulo Publicar documentación en la barra lateral izquierda.

Haga clic en +Nuevo para crear un nuevo Uso compartido rápido. Un proyecto admite varios Usos compartidos rápidos, que pueden distribuirse a diferentes colaboradores. Todos los miembros del equipo pueden ver los Usos compartidos rápidos creados por cualquier persona del equipo.

Opciones de configuración

En el cuadro de diálogo Nuevo uso compartido, puede personalizar las siguientes opciones:

Título: El nombre de este uso compartido, visible solo dentro del equipo de Apidog, utilizado para identificación interna, no visible en la documentación compartida.

Entornos: Elija los entornos disponibles en el documento en línea. De forma predeterminada, no se selecciona ningún entorno. Puede seleccionar varios entornos. Los entornos seleccionados serán visibles para los lectores en la documentación y se pueden usar para enviar peticiones al utilizar "Probar".

Entorno de Cloud Mock

Si selecciona el entorno de Cloud mock al crear la documentación, está proporcionando a los lectores un entorno sandbox sencillo para probar API sin afectar los sistemas de producción.

Contenido del documento: El documento tiene dos componentes opcionales: URL base y ejemplos de petición. Puede elegir si desea mostrarlos en el documento.

URL base: Esta es la URL base configurada en el entorno. Si se selecciona, cada interfaz del documento mostrará la URL completa; si no se selecciona, la URL del documento comenzará con "/".

Propietarios: Mostrar propietarios de esta documentación de API.

Ejemplos de petición: Si se debe mostrar código de ejemplo para llamar peticiones. Consulte ejemplos de petición para obtener detalles.

Mostrar la hora de “Última modificación” encima de la descripción del endpoint.

Mostrar la hora de “Última modificación” al final de la documentación.

Permitir datos de 'Exportar' y 'Clonar': Si se permite a los lectores exportar y clonar datos en formato OAS/Markdown/HTML/Apidog.

Alcance para compartir: Elija qué endpoints de API y Markdown incluir en este uso compartido. Puede seleccionar por directorio o filtrar y excluir por etiqueta. También puede elegir compartir toda la carpeta.

Seguridad: Puede establecer si se requiere una contraseña para acceder a este documento y la hora de caducidad de este documento. Si no se selecciona una hora de caducidad, nunca caduca.

Mostrar campos de API: Puede establecer si estos campos se muestran en el documento. Incluye: Propietarios, Hora de actualización, OperationId, Enlace original, Autorización requerida.

Idioma: La configuración de idioma aquí afectará al texto fijo funcional del documento, como "Query Params", "Request samples", etc., pero no afectará al texto escrito en el contenido de la documentación de la API.

Proxy CORS: Puede implementar y configurar el servidor proxy CORS para gestionar peticiones de endpoint en la documentación de API. Más información.

Configuración avanzada: Configure opciones como Ocultar el botón 'Probar' y Ocultar 'Powered by Apidog'.

Ejemplos de petición

Puede elegir si desea mostrar ejemplos de código de petición al crear el uso compartido.
Cómo personalizar ejemplos de petición:

En Configuración → Configuración de funciones → Configuración de funciones de endpoint → Campos de endpoint, habilite el campo Ejemplos de petición

En Endpoint → Editar, aparecerá un módulo Ejemplos de petición al final

Haga clic en Ejemplos de código de petición personalizados para añadir ejemplos en sus idiomas preferidos

Compartir toda la carpeta

Uso compartido rápido admite Compartir toda la carpeta, lo cual es ideal para escenarios en los que continúa añadiendo o eliminando documentos después de compartir. Cuando está habilitado, los colaboradores acceden automáticamente a toda la documentación de la carpeta sin requerir que usted ajuste la configuración de uso compartido para cada nuevo documento.

En la sección Alcance para compartir, seleccione Selección manual para ver la opción Compartir toda la carpeta. Cuando está habilitada, los colaboradores acceden automáticamente a toda la documentación de la carpeta.

Configuración del proxy CORS

Al compartir documentación de API con usuarios externos, estos pueden encontrar problemas de Cross-Origin Resource Sharing (CORS) al probar endpoints directamente en el navegador. Un proxy CORS resuelve esto al enrutar peticiones a través de un agente proxy designado, omitiendo las restricciones CORS del navegador y habilitando pruebas de API sin interrupciones.

Para configurar el proxy CORS, haga clic en la opción de configuración al crear una nueva documentación compartida. De forma predeterminada, Apidog ofrece Cloud Agent para gestionar peticiones de endpoint en toda la documentación compartida.

Opciones de proxy CORS

Seleccione la opción de proxy CORS que mejor se adapte a sus necesidades:

Cloud Proxy: Utiliza Cloud Agent de Apidog para gestionar peticiones de endpoint. Nota: Cloud Agent no puede acceder a endpoints en redes internas

Extensiones del navegador: Utiliza una extensión del navegador instalada en el navegador del usuario. A los usuarios sin la extensión se les pedirá que la instalen antes de realizar peticiones

Sin proxy: Las peticiones se envían directamente desde el navegador del usuario. Asegúrese de que su servidor de endpoint esté configurado para gestionar CORS correctamente

Self-hosted Request Proxy Agent: Utilice un Self-hosted Request Proxy Agent implementado dentro de su infraestructura para gestionar peticiones de endpoint

Uso compartido rápido

Requisitos previos#

Crear un Uso compartido rápido#

Opciones de configuración#

Ejemplos de petición#

Compartir toda la carpeta#

Configuración del proxy CORS#

Opciones de proxy CORS#

Requisitos previos

Crear un Uso compartido rápido

Opciones de configuración

Ejemplos de petición

Compartir toda la carpeta

Configuración del proxy CORS

Opciones de proxy CORS