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 à edição
  • 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 num formato independente de linguagem de programação. Ela cria um modelo que explica como as aplicações de software comunicam através da Internet. Os programadores 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. Esta descrição padronizada permite que outros programas interajam com a API sem terem acesso ao seu código interno.

O XMLSpy inclui 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 OAS (OpenAPI Specification). 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, incluindo discriminadores, XML, formatos e documentação externa, que podem ser configurados na ferramenta de auxílio "Detalhes".

Edição de documentos OpenAPI

Quer o seu documento OpenAPI esteja escrito em JSON ou YAML, o editor baseado em texto do XMLSpy oferece funcionalidades de edição inteligentes, como realce de sintaxe, recolhimento de código, autocompletar e ferramentas de auxílio.

Editor OpenAPI no XMLSpy

Se fizer a mudança 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 tabela oferece comandos dentro das células, edição visual por arrastar e soltar, e uma vista de tabela para reorganizar a forma como os nós são exibidos. Também é possível expandir e recolher seções dos dados para navegar por ficheiros longos e localizar elementos específicos.

Visão de edição OpenAPI com interface gráfica

Tanto a visualização em texto como a visualização em formato de tabela permitem validar os documentos em relação à especificação OpenAPI.

Quando se começa 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.

Criar requisições HTTP utilizando OpenAPI

O XMLSpy inclui uma funcionalidade útil.. Janela de testes HTTP com suporte para OpenAPI. A janela guia-o através do processo de criação e envio de uma requisição HTTP para uma API existente. Em seguida, pode receber, verificar e solucionar problemas da resposta diretamente na janela.

Assim que 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 no OpenAPI

Com base na operação e nos parâmetros que selecionar para o teste, o XMLSpy gera automaticamente a mensagem de teste, que pode enviar à API, e, em seguida, visualizar os resultados.

Testar mensagens para a API OpenAPI

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