Validando a origem YAML do OpenAPI
Como validar o arquivo YAML de origem OpenAPI em relação às especificações do Swagger ao editar uma API.
Sobre essa tarefa
Ao configurar uma API no editor de API, você pode validar o código-fonte YAML do ` OpenAPI ` clicando em . Se quaisquer erros de validação do analisador swagger forem localizados, um ícone de erro será exibido e será possível clicar para ver os erros individuais e onde eles ocorrem no YAML. Você pode então corrigir os erros, salvar as atualizações e continuar a validar o arquivo YAML OpenAPI ao longo do processo de configuração da API.
Nota:
- OpenAPI A validação não indica erros de gateway ou de política que impeçam a implementação ou a publicação da sua API. Esse tipo de validação ocorre apenas quando você tenta montar ou publicar a sua API. Para obter mais informações, consulte “Configurar uma API” ou “Publicar uma API ”.
- Você também pode validar sua documentação da API usando conjuntos de regras de governança. Para obter mais informações, consulte a seção “Validação de uma API ou de um documento de produto usando o serviço de governança ”.
É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.
Procedimento
Para validar a origem YAML OpenAPI , conclua as etapas a seguir.
- Clique em na barra de menus do cabeçalho.
- Se algum erro de validação do analisador de swagger for localizado, um ícone de erro será exibido na barra de menu do cabeçalho, com o número de erros do OpenAPI localizado próximo ao ícone. Por exemplo,
. - É possível então clicar no ícone de erro para ver uma lista detalhada dos erros e seu local no YAML. Se você estiver na visualização do
formulário, pode clicar em um erro específico para acessar diretamente a seção correspondente da API no formulário. - Quando todos os erros forem corrigidos, a validação retornará uma mensagem de êxito Por exemplo,
.