Editor e testador OpenAPI

Editar, validar e testar documentos OpenAPI

  • Editor inteligente para OpenAPI
  • Opções de edição de texto e gráficos
  • Validação baseada no OpenAPI
  • Realce da sintaxe, recolhimento de código, ferramentas de auxílio para preenchimento automático
  • Edição de esquemas JSON com base no OAS
  • Suporte para OpenAPI 1.0, 2.0 e 3.0
  • Modelos YAML para novas definições OpenAPI
  • Editores inteligentes para YAML e JSON
  • Criar e testar requisições HTTP OpenAPI

Ferramentas OpenAPI

The OpenAPI A especificação OpenAPI (anteriormente conhecida como Swagger) é um padrão que descreve APIs web em um formato independente de linguagem de programação. Ela cria um modelo que explica como as aplicações de software se comunicam através da Internet. Os desenvolvedores utilizam o OpenAPI para escrever instruções em JSON ou YAML que descrevem os detalhes da API, os pontos de acesso, os dados e as considerações de segurança. Essa descrição padronizada permite que outros programas interajam com a API sem precisar conhecer seu código interno.

O XMLSpy oferece ferramentas inteligentes para trabalhar com o OpenAPI durante o desenvolvimento ou a descoberta, incluindo validação, edição e testes.

Editor de Esquemas JSON

A representação gráfica Editor de Esquemas JSON No XMLSpy, é possível validar e editar esquemas JSON com base no padrão OAS. A interface visual facilita o trabalho dos desenvolvedores com esquemas OpenAPI complexos, oferecendo uma representação gráfica da estrutura que torna mais fácil a compreensão e a identificação de erros ou inconsistências.

O editor de esquemas JSON inclui suporte para extensões OAS, como "discriminator" (discriminador), "xml", "format" (formato) e "external docs" (documentação externa), que podem ser configuradas na ferramenta de auxílio "Details" (Detalhes).

Edição de documentos OpenAPI

Seja qual for o formato do seu documento OpenAPI, seja JSON ou YAML, o editor de texto do OpenAPI no XMLSpy oferece recursos de edição inteligentes, como realce de sintaxe, agrupamento de código, autocompletar e ferramentas de auxílio na criação.

Editor OpenAPI no XMLSpy

Se você mudar para.. Visualização em gradeO XMLSpy oferece uma representação gráfica da estrutura do documento, o que facilita a navegação, a compreensão e a edição. Além de ferramentas de edição inteligentes, a visualização em grade oferece comandos dentro das células, edição visual por arrastar e soltar, e uma visualização em tabela para reorganizar a forma como os nós são exibidos. Você também pode expandir e recolher seções dos dados para navegar por arquivos longos e localizar elementos específicos.

Visão de edição gráfica da especificação OpenAPI

Tanto a visualização em lista quanto a visualização em grade oferecem a validação de documentos em relação à especificação OpenAPI.

Ao começar do zero, o XMLSpy inclui modelos integrados para a criação de novos documentos OpenAPI, com suporte para as versões Open API 1.0, 2.0 e 3.0.

Criando requisições HTTP usando OpenAPI

O XMLSpy inclui uma janela de Testes HTTP muito útil, com suporte para OpenAPI. Essa janela guia você durante o processo de criação e envio de uma requisição HTTP para uma API existente. Em seguida, você pode receber, verificar e solucionar problemas da resposta diretamente na janela.

Depois de especificar a localização do documento OpenAPI, a janela de testes HTTP exibirá os caminhos disponíveis, juntamente com as operações correspondentes.

Operações disponíveis via OpenAPI

Com base nas configurações e parâmetros que você selecionar para o teste, o XMLSpy gera automaticamente a mensagem de teste, que você pode enviar para a API, e então visualizar os resultados.

Testar mensagens para a API OpenAPI

A capacidade de enviar requisições e analisar as respostas garante que a API se comporte conforme o esperado durante o desenvolvimento e a integração. É uma ferramenta eficaz para testar suas próprias APIs, bem como para explorar interfaces de terceiros.