API e segurança

Ferramentas OpenAPI e GraphQL

Manter um contrato de API sob controle envolve validar a definição, comparar versões e gerar dados de teste sem depender do backend real. O Validador OpenAPI confere OpenAPI 3.0, 3.1 e Swagger 2.0 revisando parâmetros, respostas e referências, o Comparador OpenAPI detecta rotas removidas, parâmetros novos e respostas alteradas entre duas versões, e o dados mock OpenAPI gera dados por operação, status e quantidade a partir de uma semente.

Para GraphQL, a Bancada GraphQL formata queries, SDL e variáveis validando as operações contra o schema completo, e o comparar schemas GraphQL mostra tipos, campos e argumentos alterados com análise de risco de cada mudança. Quem já tem uma coleção pronta usa o Postman para OpenAPI para converter a coleção Postman validando as requisições e mascarando credenciais no processo, e o conversor de cURL extrai as partes de um comando individual.

7 ferramentas

Perguntas frequentes sobre ferramentas de OpenAPI / GraphQL / Postman

Como validar um arquivo OpenAPI 3.0 ou 3.1 antes de publicar?

Cole a definição no Validador OpenAPI: ele confere OpenAPI 3.0, 3.1 e também Swagger 2.0, revisando parâmetros, respostas e referências internas do documento, e aponta onde a especificação não está sendo seguida antes que o problema chegue ao consumidor da API.

Como saber se uma mudança de contrato de API quebra clientes existentes?

O Comparador OpenAPI compara duas versões do arquivo e detecta rotas removidas, parâmetros novos e respostas alteradas, e o comparar schemas GraphQL faz o equivalente para um schema GraphQL com análise de risco de cada campo ou argumento alterado.

Como converter uma coleção do Postman para OpenAPI?

O Postman para OpenAPI lê a coleção exportada e converte para o formato OpenAPI, validando cada requisição durante a conversão e mascarando credenciais que estivessem salvas na coleção, então o arquivo resultante fica seguro para versionar junto do código do projeto.