Postman Collection – Documentação para seus serviços REST
O que é o Postman Collection?
O Postman Collection é um aplicativo para criar solicitações HTTP. Auxilia na documentação, organização e agrupamento de API relacionadas.
Possibilita que a documentação das requisições de sua API sejam organizadas em pastas e podem ser facilmente serem exportadas e compartilhadas com outras pessoas
Documentando sua API
O primeiro passo para utilizar o Postman Collections é fazer o download para o seu SO. Após o download e instalação, abra o aplicativo e selecione a opção NOVO conforme abaixo.
postman collections app
Neste tela podemos:
- Fazer requisições a serviços via HTTP para testar Endpoints
- Organizar uma coleção de serviços REST / Soap(API)
- Salvar configurações de ambiente frequentemente utilizadas
- Documentar sua API
- Criar um servidor MOCK
- Monitorar seus Endpoints
Testando Endpoints
Esta opção permite testar os endpoints passando parametros, informações no header body e autenticação;
Organizar coleção de APIS
Esta funcionalidade permite criar projetos e associar um conjunto de Endpoints com o projeto;
Salvar configurações de ambiente
Permite compartilhar informações de ambiente como banco de dados, variáveis de configuração para deploy (implantação) de um projeto.
Documentação de API
Aqui podemos definir a URL da api, seus parâmetros, resposta da requisição, formato, codigo de sucesso e erro. Além disso permite definir os parâmetros do body, header e autenticação.
Servidor MOCK
É um conjunto de endpoints simulando o comportamento do serviço. Na prática a resposta da requisição está “chumbada” no código. O serviço mock fica hospedado no site do postman collection.
Monitor
Monitora seus endpoints como se fosse uma cron para checar se os serviços estão rodando. Excelente para o ambiente de produção onde precisamos de alertas caso um determinado serviço pare de responder.
Dicas
- Escreva testes para suas apis
- Não misture os testes com a documentação. Separe!
- Organize os testes em pastas: a medida que sua api cresce fica mais complexo de manter. Crie pastas de testes organizadas por módulos!
- Reutilize código!
