La documentación de API publicada de Apidog proporciona una vista interactiva y completa de sus API. Cuando los usuarios accedan a la URL de su documentación, verán una presentación bien estructurada de cada endpoint con varias secciones diseñadas para facilitar la comprensión y las pruebas.
Esta sección muestra información esencial del endpoint, como la URL, el método HTTP, la hora de modificación y la descripción. Puede elegir qué campos mostrar al crear la documentación.
Los endpoints con estado "Released" no mostrarán una etiqueta de estado. Los endpoints con otros estados (como "Developing") mostrarán una etiqueta de estado después del nombre del endpoint. Los endpoints con estado "Deprecated" aparecen como "nombre del endpoint" en el árbol de directorios de la izquierda.
Haga clic en "Probarlo" para expandir la capa de pruebas interactivas, donde puede enviar peticiones, modificar parámetros y cambiar de entorno. Los entornos disponibles son aquellos seleccionados al crear la documentación.
Entorno de mock en la nube
Si selecciona el entorno Cloud mock al crear la documentación, estará proporcionando a los lectores un entorno sandbox sencillo para probar API.
Después de enviar la petición, puede ver la respuesta y la petición real en la página.
Puede configurar la autenticación a nivel de API o de carpeta dentro de la configuración de autenticación de su proyecto. Utilice security schemes o defina la configuración manualmente.
Después de configurar los ajustes de autenticación —por ejemplo, mediante autenticación Bearer Token— verá una sección "Credentials" en la parte superior del panel "Publish Documentation", donde puede introducir directamente el valor del token.
La principal ventaja de este enfoque de configuración es que la información de autenticación puede compartirse entre diferentes API. Si varias API hacen referencia al mismo esquema de seguridad o tipo de autenticación, solo necesita introducir la información de autenticación una vez, y otras API pueden reutilizarla automáticamente.
Estas credenciales se cifran y se almacenan en el LocalStorage del navegador, y se gestionan en función de la sesión del navegador. Dentro de la misma sesión, pueden compartirse entre varias ventanas y pestañas. Una vez que se cierra el navegador y finaliza la sesión, estas credenciales dejan de ser válidas automáticamente.Más específicamente: las credenciales almacenadas en LocalStorage están cifradas, mientras que la clave de descifrado se almacena en una cookie de sesión. Aunque los datos de LocalStorage persisten a largo plazo, la clave de descifrado en la cookie de sesión caduca en cuanto se cierra el navegador. Como resultado, los datos cifrados ya no pueden descifrarse ni accederse a ellos, y deberá volver a introducir las credenciales la próxima vez que visite la página.
Esta sección muestra las especificaciones de los parámetros y del cuerpo. Apidog admite dos estilos de visualización de parámetros —Moderno o Clásico—, que puede elegir en Settings → Feature Settings → Endpoint Feature Settings.
Si seleccionó "Allow exporting data" al crear la documentación, los lectores verán una opción Exportar en la esquina inferior derecha y al final del documento.
Los lectores pueden elegir entre "Clone" o "Export". "Export" admite la exportación en los formatos OAS, HTML, Markdown y Apidog.
