Guardar peticiones como endpoints

Después de enviar correctamente una petición de API, Apidog puede analizar automáticamente los datos de la petición y la respuesta para crear una especificación completa del endpoint. Esta potente función ahorra tiempo y garantiza que su documentación de API refleje con precisión el comportamiento real.

Analizar la petición en una especificación de endpoint

Una petición enviada correctamente, si aún no está definida, puede ser analizada automáticamente por Apidog para convertirla en una especificación de endpoint.

Después de enviar la petición, puede hacer clic en el menú desplegable junto al botón Save y seleccionar Save as endpoint para guardarla como una especificación de endpoint.

Cuando guarda una petición como endpoint, Apidog extrae de forma inteligente la siguiente información:

Parámetros de la petición: Los tipos de parámetros de la petición actual se tratarán como la especificación de parámetros de la petición en el endpoint, y los valores actuales de los parámetros se considerarán valores de ejemplo para los parámetros de la petición.

Esquema de respuesta: La estructura de datos de la respuesta de la petición actual se analizará como la especificación de respuesta, y los valores de la respuesta se tratarán como un ejemplo de respuesta.

Esta función resulta especialmente útil al trabajar con API existentes o cuando desea documentar rápidamente una API basándose en datos reales de petición/respuesta, en lugar de definir manualmente el esquema.

Extraer la respuesta

Apidog admite la extracción de respuestas en la especificación del endpoint, que pueden extraerse como esquema de respuesta o ejemplos de respuesta.

Esta flexibilidad le permite elegir si desea actualizar la definición del esquema del endpoint o simplemente añadir un nuevo ejemplo de respuesta con fines de documentación y prueba.

Extraer respuestas como esquemas es útil cuando la estructura de la API ha cambiado, mientras que extraerlas como ejemplos es mejor para documentar diferentes escenarios de respuesta (éxito, errores, casos límite).

Guardar peticiones como endpoints

Analizar la petición en una especificación de endpoint#

Extraer la respuesta#

Analizar la petición en una especificación de endpoint

Extraer la respuesta