O módulo de APIs do Apidog inclui dois modos que podem ser alternados no canto inferior esquerdo da interface: Modo Design-first e Modo Request-first.Ambos os modos disponibilizam funcionalidades semelhantes, mas com interfaces diferentes, adequando-se a diferentes fluxos de trabalho das equipas.O Modo Design-first é o modo recomendado pelo Apidog, adequado para equipas que seguem a abordagem API-Design First. Neste modo, as equipas especificam primeiro a API e, em seguida, avançam com o desenvolvimento e os testes com base na especificação da API.Por outro lado, o Modo Request-first é ideal para equipas que não definem inicialmente as especificações da API. Estas equipas normalmente concentram-se no desenvolvimento do backend, finalizam o código e, depois, produzem a especificação da API para que os testes e o trabalho do lado do cliente possam começar.Se precisar de chamar APIs desenvolvidas por outra pessoa, mas não tiver a documentação, também deverá utilizar o Modo Request-first.
Modo Design-First#
No Modo Design-first, a edição da especificação da API e o envio de pedidos são acedidos através de separadores distintos. Os utilizadores modificam a especificação da API no separador Edit e enviam pedidos no separador Run.Esta separação é adequada para equipas que seguem a abordagem API-Design First, na qual os arquitetos de API e os programadores/consumidores têm funções distintas. Os arquitetos de API definem a especificação da API sem enviar pedidos, enquanto os programadores se concentram no desenvolvimento e nos testes da API sem alterar a especificação da API.Os separadores divididos estão alinhados com os hábitos de utilização dessas equipas. No separador Edit, os arquitetos de API podem especificar exemplos de pedidos, que são automaticamente definidos como valores predefinidos de parâmetros no separador Run. Os programadores/consumidores da API podem modificar ainda mais os valores dos parâmetros e os corpos dos pedidos no separador Run.Modo Request-First#
O Modo Request-first é adequado para equipas que não especificam APIs antecipadamente. Os programadores de backend trabalham diretamente no desenvolvimento da API e podem precisar de chamar APIs para depuração durante o desenvolvimento.Neste modo, os programadores não precisam de especificar inicialmente a API; em vez disso, podem introduzir diretamente um pedido, de forma semelhante à criação de um novo pedido no Postman. Nesta interface, os programadores podem modificar facilmente tipos, nomes e valores de parâmetros, componentes do corpo e muito mais, sem necessidade de ajustar separadamente a especificação da API e os valores dos parâmetros do pedido.Assim que a depuração é concluída e guardada, o pedido é automaticamente analisado e convertido numa especificação de endpoint. Os parâmetros são traduzidos em parâmetros de especificação e valores de exemplo, enquanto o corpo do pedido/resposta é analisado e convertido num schema, e os valores do corpo são interpretados como exemplos de pedido/resposta. Os programadores podem refinar e melhorar ainda mais esta especificação de endpoint com base nos seus requisitos.Diferenças Entre os Modos#
A principal diferença entre os dois modos é que, no Modo Request-first, o corpo do pedido é utilizado como exemplo de corpo do pedido do endpoint. Em contraste, no Modo Design-first, os utilizadores podem introduzir um corpo de pedido real no separador Run, juntamente com o exemplo de corpo do pedido. Portanto, a secção do corpo no separador Run está disponível APENAS no Modo Design-first e não é visível no Modo Request-first.Outra diferença é que, no Modo Design-first, pode adicionar um pré/pós-processador ao nível da especificação do endpoint ou ao nível da execução/caso de endpoint. Já no Modo Request-first, como não existe separador Run, todos os pré/pós-processadores são considerados como estando ao nível da especificação do endpoint. Os pré/pós-processadores ao nível da execução/caso de endpoint ficam invisíveis no Modo Request-first. 