Actualmente, la mayoría de las API se diferencian según el método y la ruta. Sin embargo, algunos proyectos de desarrollo (como algunos documentos de API de comercio electrónico) utilizan una URL fija para la petición de API y diferencian las API mediante parámetros en Query / Header.Después de la versión 2.2.9, Apidog añadió la función de identificación única de endpoints, que admite OperationId, parámetros Query, parámetros Body y parámetros Header como parámetros para diferenciar entre API.
Configuración de la identificación única de endpoints#
El ID único del endpoint se define a nivel de directorio. Cuando necesite establecer una API como identificación única, debe configurarlo en su directorio principal. Haga clic en el directorio y elija el parámetro de identificación única según sus necesidades; después de hacer clic en guardar, surtirá efecto en todas las API de ese directorio.
Para este ejemplo, elegiremos el parámetro Query y escribiremos OperationID dentro del nombre del parámetro.
Después de configurar la identificación única de endpoints para el directorio, haga clic en una API de ese directorio, haga clic en la pestaña operationid y, tanto en la información básica como en los parámetros de petición en la parte inferior de la API, hay un icono de K, que representa el parámetro para el ID único del endpoint.
Puede introducir el valor correspondiente bajo el parámetro correspondiente como valor para la identificación única del endpoint.
Si utiliza parámetros en Query/Header para distinguir entre API en su proyecto e importa un archivo con formato OpenAPI en Apidog, aparecerá la siguiente página.La regla para hacer coincidir las API durante la importación está sujeta a la configuración del directorio de destino. Si la configuración de la identificación única del endpoint en el directorio de destino no cumple los requisitos, puede modificarla en la configuración de importación. Después de la modificación, surtirá efecto directamente en el directorio de destino.Como ejemplo, importaremos este directorio y crearemos un ID único de endpoint para él con Query Param y Param Name llamado action.
Recuerde: si su directorio ya tiene un ID único, la nueva importación no puede sobrescribirlo.
Notas importantes
1.
Los usuarios que hayan utilizado el Fixed Value en parámetros Query no deben preocuparse, porque esta función se seguirá conservando. Sin embargo, al importar, el Fixed Value se evalúa según la URL, por lo que se recomienda que los usuarios que hayan utilizado el Fixed Value usen la identificación única de endpoints.
2.
La identificación única de endpoints admite la configuración de varios parámetros.
3.
Si solo un subdirectorio de su directorio está configurado como identificación única de endpoints, al importar Swagger y actualizar todos los directorios, evite importar todos los proyectos al directorio raíz para actualizarlos. Se recomienda importar las API configuradas como identificación única de endpoints por separado en ese directorio especial.
A partir de la versión 2.2.24, si la API ha establecido el identificador único como parámetro Body o parámetro Header, debe enviar la ruta + el nombre y el valor del parámetro del identificador único para obtener los datos mock correspondientes.
Prácticas recomendadas para datos mock
1.
Al acceder a datos mock durante el desarrollo, los desarrolladores frontend también deben enviar la ruta + el nombre y el valor del parámetro del identificador único si la API ha establecido el identificador único como parámetro Body o parámetro Header.
2.
En los proyectos que tienen un identificador único para las API, la documentación de la API debe estandarizarse para evitar casos en los que las API tengan la misma URL pero no tengan configurado un identificador único. Esto se hace para evitar errores al obtener correctamente los datos mock.
