¿Cómo compartir encabezados (por ejemplo, token) en la documentación en línea de Apidog?

Tengo que introducir manualmente el mismo encabezado cada vez que uso “Try It” para probar una API. ¿Hay alguna forma de compartirlo automáticamente?

Sí. Se recomienda usar variables para compartir encabezados entre peticiones de API. Estos son dos enfoques comunes:

Método 1: Use una variable directamente en el encabezado de la API

Configure el encabezado de esta forma en su definición de API:

Al usar la función “Try It” en la documentación en línea, los usuarios solo necesitan introducir el valor de ACCESS_TOKEN una vez en la parte superior. Todas las API que hagan referencia a {{ACCESS_TOKEN}} rellenarán automáticamente el valor, sin necesidad de introducirlo repetidamente.

Método 2: Defina parámetros de encabezado globales usando una variable

Vaya a Gestión de entornos → Parámetros globales

Añada un parámetro de tipo encabezado, por ejemplo:

Las API del proyecto usarán este parámetro global de forma predeterminada. También puede optar por habilitarlo o deshabilitarlo para API específicas.

La documentación en línea heredará automáticamente el valor de la variable, lo que permitirá que varias API lo compartan.

Tanto si define la variable directamente en el encabezado de la API como si la referencia mediante parámetros globales, siempre que se use el mismo nombre de variable (por ejemplo, {{ACCESS_TOKEN}}), solo tendrá que introducirla una vez en la documentación en línea. Luego se compartirá entre todas las peticiones relevantes, lo que mejorará considerablemente la experiencia de prueba.

¿Cómo compartir encabezados (por ejemplo, token) en la documentación en línea de Apidog?

Método 1: Use una variable directamente en el encabezado de la API#

Método 2: Defina parámetros de encabezado globales usando una variable#

Método 1: Use una variable directamente en el encabezado de la API

Método 2: Defina parámetros de encabezado globales usando una variable