O módulo de APIs do Apidog conta com dois modos que podem ser alternados no canto inferior esquerdo da interface: Modo Design-first e Modo Request-first.Ambos os modos oferecem funcionalidades semelhantes, mas com interfaces diferentes, atendendo a diferentes fluxos de trabalho de equipes.O Modo Design-first é o modo recomendado pelo Apidog, adequado para equipes que seguem a abordagem API-Design First. Nesse modo, as equipes especificam a API primeiro e, em seguida, prosseguem com o desenvolvimento e os testes com base na especificação da API.Por outro lado, o Modo Request-first é ideal para equipes que não definem inicialmente as especificações da API. Essas equipes normalmente se concentram no desenvolvimento de backend, finalizam o código e, então, produzem a especificação da API para que os testes e o trabalho no lado do cliente comecem.Se você precisar chamar APIs desenvolvidas por outra pessoa, mas não tiver a documentação, também deverá usar o Modo Request-first.
Modo Design-First#
No Modo Design-first, a edição da especificação da API e o envio de requisições são acessados por meio de abas separadas. Os usuários modificam a especificação da API na aba Edit e enviam requisições na aba Run.Essa separação atende às equipes que seguem a abordagem API-Design First, em que arquitetos de API e desenvolvedores/consumidores têm funções distintas. Arquitetos de API definem a especificação da API sem enviar requisições, enquanto desenvolvedores se concentram no desenvolvimento e nos testes da API sem alterar a especificação da API.As abas divididas se alinham aos hábitos de uso dessas equipes. Na aba Edit, arquitetos de API podem especificar exemplos de requisição, que são definidos automaticamente como valores de parâmetro padrão na aba Run. Desenvolvedores/consumidores de API podem modificar ainda mais os valores de parâmetros e os corpos de requisição na aba Run.Modo Request-First#
O Modo Request-first é adequado para equipes que não especificam APIs antecipadamente. Desenvolvedores de backend trabalham diretamente no desenvolvimento da API e podem precisar chamar APIs para depuração durante o desenvolvimento.Nesse modo, os desenvolvedores não precisam especificar a API inicialmente; em vez disso, podem inserir uma requisição diretamente, de forma semelhante à criação de uma nova requisição no Postman. Nessa interface, os desenvolvedores podem modificar facilmente tipos, nomes e valores de parâmetros, componentes do corpo e muito mais, sem a necessidade de ajustar separadamente a especificação da API e os valores dos parâmetros da requisição.Depois que a depuração é concluída e salva, a requisição é automaticamente analisada em uma especificação de endpoint. Os parâmetros são traduzidos em parâmetros de especificação e valores de exemplo, enquanto o corpo da requisição/resposta é analisado em um schema, e os valores do corpo são interpretados como exemplos de requisição/resposta. Os desenvolvedores podem refinar e aprimorar ainda mais essa especificação de endpoint com base em seus requisitos.Diferenças entre os modos#
A principal diferença entre os dois modos é que, no Modo Request-first, o corpo da requisição é usado como o exemplo de corpo da requisição do endpoint. Em contraste, no Modo Design-first, os usuários podem inserir um corpo de requisição real na aba Run junto com o exemplo de corpo da requisição. Portanto, a seção de corpo na aba Run está disponível SOMENTE no Modo Design-first e não é visível no Modo Request-first.Outra diferença é que, no Modo Design-first, você pode adicionar um pré/pós-processador no nível da especificação do endpoint ou no nível da execução/caso de endpoint. Enquanto isso, no Modo Request-first, como não há aba Run, todos os pré/pós-processadores são considerados no nível da especificação do endpoint. Os pré/pós-processadores no nível da execução/caso de endpoint ficam invisíveis no Modo Request-first. 