Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Crie e valide especificações da OpenAPI sem escrever código usando o editor de especificações.
Acessar o editor de especificações
Abra uma especificação da OpenAPI no editor de especificação, conforme descrito nas seções a seguir:
- Criar uma nova especificação da OpenAPI
- Importar uma especificação OpenAPI
- Editar uma especificação OpenAPI
A figura a seguir mostra a especificação da API Petstore aberta no editor de especificação:
Conforme destacado na figura anterior, o editor de especificações permite:
- Crie a especificação OpenAPI para modelar sua API usando o formato JSON ou YAML no painel à esquerda.
- Confira a documentação da API gerada automaticamente no painel à direita.
- Valide sua especificação com o padrão da especificação OpenAPI enquanto você digita.
- Salve sua especificação OpenAPI ou feche a especificação e cancele as edições.
Me ajudar com JSON e YAML
JSON (JavaScript Object Notation) é um formato leve de intercâmbio 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 representação/serialização de dados que fornece uma sintaxe que também pode ser mapeada para estruturas de dados, como listas, matrizes associativas e escalares. Para saber mais, consulte https://yaml.org.
JSON e YAML são legíveis por máquina, mas também são fáceis de ler e entender por humanos. A figura a seguir compara dois trechos curtos da mesma especificação da OpenAPI escrita usando JSON e YAML:
Validar uma especificação
O editor de especificação valida sua especificação OpenAPI em relação ao padrão da especificação OpenAPI. Ao digitar, se houver erros na especificação da OpenAPI, o editor de especificações 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.
Salvar uma especificação
Para salvar uma especificação da OpenAPI, clique em Salvar na barra de navegação de cima.
Se esta for a primeira vez que você salvar 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 o arquivo mais tarde.
Fechar uma especificação
Para fechar uma especificação da OpenAPI sem salvar as edições, clique em Cancelar na barra de navegação na parte de cima. Você volta à lista de especificações.