Validation de la définition YAML ou JSON d'une API ou d'un produit
Vous pouvez valider une définition YAML ou JSON à l'aide de IBM® API Connect toolkit de développement.
Avant de commencer
Procédure
Pour effectuer la validation à l'aide du kit d'outils de développement, entrez la commande suivante:
apic validate filename
où nom_fichier est le nom de fichier du fichier de définition d'API que vous voulez valider.
- Incluez --product-only pour valider une définition de produit, mais pas les API auxquelles elle fait référence.
- Incluez --no-extensions pour valider uniquement la section OpenAPI par défaut de l'API et aucune de ses extensions.
Remarque :
- Si le fichier OpenAPI qui définit votre API utilise une zone
$refpour référencer un fragment de code OpenAPI défini dans un fichier distinct, la zone$refest remplacée par le contenu du fichier cible avant que le brouillon d'API ne soit créé à l'aide de la commande apic drafts:validate . Pour plus d'informations, voir Utilisation de $ref pour réutiliser des fragments de code dans vos fichiers OpenAPI. - Les produits comportant une API avec une propriété Swagger utilisant des expressions régulières (regex) incluant des assertions d'anticipation, telles que "
(?", ne peuvent pas être validés ou publiés. Un message d'erreur est renvoyé. Par exemple :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