Atualmente, a maioria das APIs é diferenciada com base no método e caminho. No entanto, alguns projetos de desenvolvimento (como alguns documentos de API de e-commerce) usam uma URL fixa para a requisição de API e diferenciam as APIs usando parâmetros em Query / Header.Após a versão 2.2.9, o Apidog adicionou o recurso de identificação única de endpoint, que oferece suporte a OperationId, parâmetros de Query, parâmetros de Body e parâmetros de Header como parâmetros para diferenciar APIs.
O ID único do endpoint é definido no nível de diretório. Quando você precisa definir uma API como uma identificação única, é necessário configurá-la em seu diretório pai. Clique no diretório e escolha o parâmetro de identificação única de acordo com suas necessidades; após clicar em salvar, ele entrará em vigor para todas as APIs dentro desse diretório.
Para este exemplo, escolheremos o parâmetro Query e escreveremos OperationID dentro do nome do parâmetro.
Preenchimento do Valor do Parâmetro Correspondente#
Após configurar a identificação única de endpoint para o diretório, clique em uma API dentro desse diretório, clique na aba operationid e, tanto nas informações básicas quanto nos parâmetros da requisição na parte inferior da API, há um ícone de K, que representa o parâmetro do ID único do endpoint.
Você pode inserir o valor correspondente no parâmetro correspondente como o valor para a identificação única de endpoint.
Se você usa parâmetros em Query/Header para distinguir APIs em seu projeto e importa um arquivo no formato OpenAPI para o Apidog, a página a seguir será exibida.A regra para correspondência de APIs durante a importação está sujeita às configurações do diretório de destino. Se a configuração da identificação única de endpoint no diretório de destino não atender aos requisitos, você pode modificá-la nas configurações de importação. Após a modificação, ela entrará em vigor diretamente no diretório de destino.Como exemplo, importaremos este diretório e criaremos um ID único de endpoint para ele com Query Param e Param Name chamado action.
Lembre-se: se o seu diretório já tiver um ID único, a nova importação não poderá substituí-lo.
Observações Importantes
1.
Usuários que utilizaram o Fixed Value em parâmetros de Query não precisam se preocupar, pois essa função ainda será mantida. No entanto, ao importar, o Fixed Value é avaliado com base na URL, portanto, recomenda-se que usuários que utilizaram o Fixed Value usem a identificação única de endpoint.
2.
A identificação única de endpoint oferece suporte à configuração de múltiplos parâmetros.
3.
Se apenas um subdiretório em seu diretório estiver definido como identificação única de endpoint, ao importar Swagger e atualizar todos os diretórios, evite importar todos os projetos para o diretório raiz para atualização. Recomenda-se importar separadamente as APIs configuradas como identificação única de endpoint para esse diretório especial.
A partir da versão 2.2.24, se a API tiver definido o identificador único como Parâmetro de Body ou Parâmetro de Header, você precisará enviar o caminho + nome e valor do parâmetro do identificador único para obter os Dados de Mock correspondentes.
Práticas Recomendadas para Dados de Mock
1.
Ao acessar Dados de Mock durante o desenvolvimento, desenvolvedores frontend também precisam enviar o caminho + nome e valor do parâmetro do identificador único se a API tiver definido o identificador único como Parâmetro de Body ou Parâmetro de Header.
2.
Para projetos que têm um identificador único para APIs, a documentação da API precisa ser padronizada para evitar casos em que APIs tenham a mesma URL, mas não tenham um identificador único configurado. Isso serve para evitar falhas ao obter Dados de Mock corretamente.
