Esquema de seguridad en la documentación en línea

Cómo se muestran los esquemas de seguridad en la documentación en línea

Apidog muestra automáticamente el método de autenticación (esquema de seguridad) de cada endpoint en la documentación en línea. Esto ayuda a los usuarios a identificar fácilmente cómo autenticar sus peticiones.

Esquema de seguridad único

Varios esquemas de seguridad

Cómo aparece el esquema de seguridad OAuth 2.0 en la documentación

Si un endpoint utiliza OAuth 2.0, la documentación proporciona información más detallada, que incluye:

Tipo de concesión

URL relacionadas (URL de autorización, URL de token, etc.)

Alcances disponibles con descripciones

Alcances requeridos para el endpoint

Esquema de seguridad OAuth 2.0 en la documentación

Depuración de endpoints en la documentación en línea

Para proteger los datos de los usuarios, Apidog separa el método de autenticación de las credenciales de autenticación. Esto significa que, aunque los valores de autenticación predeterminados estén configurados en el nivel de carpeta o de endpoint, no se aplicarán automáticamente durante la depuración en línea. Deberá introducir las credenciales manualmente.

Vaya a la documentación de la API en línea.

Haga clic en Try it para abrir el panel de depuración del endpoint. En la sección Auth, introduzca las credenciales de autenticación requeridas.

Estas credenciales se utilizarán para las peticiones enviadas desde el endpoint actual.

Depurar endpoints en la documentación en línea

Esquema de seguridad en la documentación en línea

Cómo se muestran los esquemas de seguridad en la documentación en línea#

Esquema de seguridad único#

Varios esquemas de seguridad#

Cómo aparece el esquema de seguridad OAuth 2.0 en la documentación#

Depuración de endpoints en la documentación en línea#

Cómo se muestran los esquemas de seguridad en la documentación en línea

Esquema de seguridad único

Varios esquemas de seguridad

Cómo aparece el esquema de seguridad OAuth 2.0 en la documentación

Depuración de endpoints en la documentación en línea