Convalida della definizione YAML o JSON di un'API o di un prodotto

Puoi convalidare una definizione YAML o JSON utilizzando il IBM® API Connect developer toolkit.

Prima di iniziare

Per completare i passaggi descritti in questo argomento, devi aver installato il toolkit sviluppatori. Per ulteriori informazioni, vedere Installazione del toolkit.

Procedura

Per eseguire la convalida utilizzando il toolkit sviluppatori, immettere il seguente comando:
apic validate filename

dove filename è il nome file del file di definizione API che si desidera convalidare.

  • Includere --product-only per convalidare solo una definizione del prodotto e non le API a cui fa riferimento.
  • Includi --no-extensions per convalidare solo la sezione OpenAPI predefinita dell'API e nessuna delle sue estensioni.
Nota:
  • Se il file di OpenAPI che definisce la propria API utilizza un campo $ref per fare riferimento a un frammento di codice OpenAPI definito in un file separato, il campo $ref viene sostituito con il contenuto del file di destinazione prima che l'API bozza venga creata con il comando apic drafts:validate . Per ulteriori informazioni, vedi Utilizzo di $ref per riutilizzare i frammenti di codice nei tuoi file OpenAPI.
  • I prodotti che contengono un'API con una proprietà Swagger che utilizza regex che include le asserzioni lookahead, come "(?", non possono essere convalidati o pubblicati. Viene restituito un messaggio di errore. Ad esempio:
    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