Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Criar e validar 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ções, conforme descrito nas seguintes seções:
- Crie uma nova especificação OpenAPI
- Importar uma especificação OpenAPI
- Editar uma especificação OpenAPI existente
A figura abaixo mostra a especificação da API Petstore aberta no editor de especificações:
Conforme destacado na figura anterior, o editor de especificações permite:
- Crie uma especificação OpenAPI para modelar a API usando o formato JSON ou YAML no painel esquerdo.
- Confira a documentação da API gerada automaticamente no painel direito.
- Valide sua especificação em relação ao padrão da especificação OpenAPI enquanto você digita.
- Salve a especificação OpenAPI ou feche a especificação e cancele as edições.
Quero ajuda 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.
O YAML (YAML Ain't Markup Language) é um padrão de serialização/representação de dados que fornece uma sintaxe que 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 para humanos. A figura a seguir compara dois trechos curtos da mesma especificação OpenAPI escritas usando JSON e YAML:
Validar uma especificação
O editor de especificações valida sua especificação OpenAPI em relação ao padrão de especificação OpenAPI. Conforme você digita, se houver erros na especificação OpenAPI, o editor de especificações exibe a caixa de diálogo "Erro" na parte superior do painel direito e fornece 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 OpenAPI, clique em Save na barra de navegação superior.
Se estiver salvando a especificação pela primeira vez, você será solicitado a inserir um nome de arquivo. Se você não especificar um nome de arquivo, o padrão será Sem título. Você pode renomeá-la mais tarde.
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ê retorna à lista de especificações.