Editor e testador 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.

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.

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.

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 2.0, 3.0, 3.1 e 3.2.

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.

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.

Pode também gerar uma requisição diretamente a partir do ficheiro OpenAPI que está a editar. Clique com o botão direito em qualquer operação e o XMLSpy lerá o seu caminho, método, parâmetros e corpo da requisição, abrindo uma requisição pronta a ser enviada na janela de testes HTTP.

Os testes abrangem toda a gama de pedidos que uma API típica aceita, incluindo pedidos multipart/form-data para o envio de ficheiros e conteúdo misto. Quando uma operação espera um corpo multipart, o XMLSpy preenche automaticamente as partes com base na definição OpenAPI, para que apenas tenha de preencher os valores e os caminhos dos ficheiros e enviar.

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.