Criar especificações usando o editor de especificações

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Crie e valide especificações OpenAPI sem escrever código usando o editor de especificações.

Acessar o editor de especificações

Abra uma especificação OpenAPI no editor de especificação, conforme descrito nas seções a seguir:

A figura a seguir mostra a especificação da API Petstore aberta no editor de especificações:

Como destacado na figura anterior, o editor de especificações permite:

  • Crie sua especificação OpenAPI para modelar sua API usando o formato JSON ou YAML no painel esquerdo.
  • Confira a documentação da API gerada automaticamente no painel à direita.
  • Valide sua especificação em relação ao padrão da especificação OpenAPI enquanto digita.
  • Salve a especificação OpenAPI ou feche a especificação e cancele as edições.

Me ajude com JSON e YAML

JSON (JavaScript Object Notation) é um formato leve de troca de dados usado para representar estruturas de dados simples e matrizes associativas. Para saber mais, acesse https://www.json.org.

YAML (YAML Ain't Markup Language) é um padrão de serialização/representação de dados que oferece uma sintaxe que também pode ser mapeada para estruturas de dados, como listas, matrizes associativas e escalares. Para saber mais, acesse https://yaml.org.

Os dois formatos são legíveis por máquinas, mas também são fáceis de ler e entender por pessoas. A figura a seguir compara dois pequenos trechos da mesma especificação OpenAPI escrita usando JSON e YAML:

JSON x YAML

Validar uma especificação

O editor de especificações valida sua especificação OpenAPI em relação ao padrão da especificação OpenAPI. À medida que você digita, se houver erros na sua especificação OpenAPI, o editor vai mostrar a caixa de diálogo "Erro" na parte de cima do painel direito e fornecer mais informações sobre os erros e os números de linha associados para que você possa corrigi-los facilmente.

Erros

Salvar uma especificação

Para salvar uma especificação OpenAPI, clique em Salvar na barra de navegação superior.

Se for a primeira vez que você salva a especificação, será necessário inserir um nome de arquivo. Se você não especificar um nome de arquivo, o padrão será "Sem título". Você pode renomear depois.

Fechar uma especificação

Para fechar uma especificação OpenAPI sem salvar as edições, clique em Cancelar na barra de navegação superior. Você volta para a lista de especificações.