Testando a API REST usando o Postman

Testando a API REST usando o Postman
Postman é um software que você pode usar para testar APIs de descanso. Postman tem uma interface de usuário gráfica fácil de usar. Ele também tem muitos recursos úteis para ajudá -lo a testar sua API REST. Postman está disponível para Windows, Mac e Linux. Postman também está disponível como um plugin Chrome. Então, você pode usar o Postman dentro do seu navegador do Google Chrome. Postman tem uma versão gratuita e versões pagas. Você pode fazer quase tudo com a versão gratuita. Vou usar a versão gratuita neste artigo.

Neste artigo, mostrarei como testar a API REST usando o Postman. Vamos começar.

Instalando o Postman como uma extensão do Chrome:

Nesta seção, mostrarei como instalar o Postman na Chrome Web Store.

Primeiro, vá para a página de extensão do Postman na Chrome Web Store em https: // Chrome.Google.com/webstore/detalhe/postman/fhbjgbiflinjbdggehcddcbncdddomOp?hl = en

Agora clique em Adicionar ao Chrome.

Agora, clique em Adicionar aplicativo.

Postman deve ser instalado. Agora você pode clicar em Lançamento do Aplicativo Para começar o Postman.

Ou, você pode clicar em Aplicativos.

E comece o Postman a partir daí.

Se você abrir o Postman pela primeira vez, verá a seguinte janela. Clique no link marcado na captura de tela abaixo se você não tiver uma conta ou não quiser fazer login.

Postman deve começar.

Janela principal do Postman:

Você também pode instalar o Postman nativamente no Linux. Está fora do escopo deste artigo. Então, eu não sou capaz de mostrar aqui.

Configurando um servidor de API de teste:

Eu escrevi uma API usando o nó.JS que usarei neste artigo para mostrar como usar o Postman para testar APIs. Se você quiser acompanhar, você pode apenas clonar meu repositório do GitHub Angular-herói-api e execute o mesmo servidor de API que eu.

Clone meu repositório do GitHub com o seguinte comando:

$ git clone https: // github.com/shovon8/hero-api angular

Agora, navegue para o Angular-herói-api/ diretório:

$ CD Angular-herói-api/

Agora, instale todos os módulos de nós necessários:

$ npm install

Por fim, inicie o servidor da API com o seguinte comando:

Teste de $ NPM

Como você pode ver, o servidor API está em execução na porta 4242.

Noções básicas de Postman:

Primeiro, Postman aberto e deve parecer algo assim.

Você pode digitar o URL do seu terminal de API na seção marcada da captura de tela abaixo.

Você pode selecionar o método de solicitação (como get, postar, colocar etc.) no menu suspenso, marcado na captura de tela abaixo.

Uma vez, terminar, clique em Enviar Para enviar seu pedido de API. O resultado deve ser exibido.

Você verá como tudo funciona na próxima seção deste artigo.

Usando o Postman para testar as APIs REST:

Se você deseja executar uma solicitação GET na sua API, digite o URL do seu endpoint da API, defina o método para PEGAR, e finalmente clique em Enviar.

Por exemplo, para obter uma lista de todos os heróis no banco de dados, faça um PEGAR solicitação ao servidor de API /API/HEROUS endpoint. Depois de pressionar Enviar, A saída deve ser exibida no formato JSON, como você pode ver na captura de tela abaixo.

Você também pode fazer uma solicitação de postagem em seu servidor de API usando o Postman. Eu configurei meu servidor de API de uma maneira que ele cria um novo herói no pedido de postagem. Para criar um novo herói, defina o método para PUBLICAR e o terminal da API para /api /heróis; Em seguida, clique em Corpo conforme marcado na captura de tela abaixo.

Agora, clique em cru e selecione JSON (APLICAÇÃO/JSON) No menu suspenso de tipo, marcado na captura de tela abaixo.

Por fim, digite as informações do herói que você deseja inserir no formato JSON e clique em Enviar.

Como você pode ver, o herói é inserido com o ID 21.

Todos os seus pedidos de API que você faz são salvos na história do Postman. Para usar uma solicitação de API do histórico, basta clicar nele e clicar em Enviar.

Como você pode ver, a solicitação da API para listar todos os heróis que fizemos anteriormente está listada na história. Depois de clicar nele, ele deve abrir em uma nova guia. Finalmente, clique em Enviar.

Como você pode ver, todos os heróis estão listados, incluindo nosso novo herói.

Você também pode excluir um herói da lista usando o EXCLUIR método no/api/herói/ endpoint. Aqui, é o id do herói que você deseja excluir.

Então, digamos, você quer remover o herói com o id 20. Então o endpoint da API é /API/HERO/20 E o método é EXCLUIR. Como você pode ver, um sucesso a mensagem é retornada. O herói deve ser excluído.

Como você pode ver, o herói com o ID 20 é excluído.

Antes, mostrei como enviar informações no formato JSON para o servidor API. Aqui, vou mostrar como enviar informações em formato codificado de URL. Quando você envia um formulário HTML para o servidor, este é o formato usado por padrão.

Digamos, você deseja atualizar um herói na API, o servidor. Para fazer isso, você tem que usar o CORREÇÃO método em/api/herói/ endpoint como é isso que eu configurei no meu servidor de API. Aqui o é o id do herói que você deseja atualizar.

Por exemplo, vamos mudar o nome do herói com o id 19 de Magma para homem Morcego. Então, o endpoint da API deve ser /API/HERO/19 e o método deve ser CORREÇÃO. Agora, clique em Corpo e também selecione X-WWW-Form-Form-Urlencoded conforme marcado na captura de tela abaixo.

Agora, defina a chave para nome e valor para homem Morcego conforme marcado na captura de tela abaixo. Finalmente, clique em Enviar.

Como você pode ver, os dados atualizados são exibidos. O que significa que a operação de atualização é bem -sucedida.

Se você listar todos os heróis novamente, verá os dados atualizados, como pode ver na captura de tela abaixo.

Então, esse é o básico do Postman. Postman tem toneladas de recursos e opções que você pode usar para tornar sua vida como um desenvolvedor de API fácil. Obrigado por ler este artigo. Divirta -se com seu carteiro!