Validando a definição de YAML ou JSON de uma API ou um Produto

Editar online

É possível validar uma definição YAML ou JSON usando o IBM® API Connect kit de ferramentas do desenvolvedor.

Antes de Iniciar

Para concluir as etapas descritas neste tópico, deve-se ter instalado o kit de ferramentas do desenvolvedor. Para mais informações, consulte Configurando o API Connect kit de ferramentas.

Procedimento

Para executar a validação usando o developer toolkit, insira o comando a seguir:
apic validate filename

em que filename é o nome do arquivo de definição de API que você deseja validar.

  • Inclua --product-only para validar somente uma definição de Produto e não qualquer API que ele referencie.
  • Inclua --no-extensions para validar apenas a seção OpenAPI padrão da API e nenhuma de suas extensões
Nota:
  • Se o arquivo OpenAPI que define sua API usar um campo $ref para fazer referência a um fragmento do código OpenAPI que é definido em um arquivo separado, o campo $ref será substituído pelo conteúdo do arquivo de destino antes que a API de rascunho seja criada com o comando apic drafts:validate . Para obter mais informações, consulte Usando $ref para reutilizar fragmentos de código em seus arquivos OpenAPI..
  • Os produtos que contêm uma API com uma propriedade Swagger usando regex que incluem asserções lookahead, como "(?" não podem ser validados ou publicados. Uma mensagem de erro é retornada. Por exemplo:
    Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400