Validación de la definición YAML o JSON de una API o un producto

Puede validar una definición YAML o JSON utilizando IBM® API Connect kit de herramientas de desarrollador.

Antes de empezar

Para completar los pasos que se describen en este tema, debe haber instalado el kit de herramientas del desarrollador. Para obtener más información, consulte Configuración del kit de herramientas de API Connect .

Procedimiento

Para realizar la validación utilizando el kit de herramientas de desarrollador, especifique el mandato siguiente:
apic validate filename

donde nombre_archivo es el nombre de archivo del archivo de definición de API que desea validar.

  • Incluya --product-only para validar solo una definición de producto y no las APIs a las que haga referencia.
  • Incluya --no-extensions para validar sólo la sección OpenAPI predeterminada de la API y ninguna de sus extensiones.
Nota:
  • Si el archivo OpenAPI que define la API utiliza un campo $ref para hacer referencia a un fragmento de código OpenAPI definido en un archivo independiente, el campo $ref se sustituye por el contenido del archivo de destino antes de que se cree el borrador de API con el mandato apic drafts:validate . Para obtener más información, consulte Utilización de $ref para reutilizar fragmentos de código en los archivos OpenAPI.
  • Los productos que contienen un API con una propiedad Swagger que usa una expresión regular que incluye aserciones de búsqueda anticipada como, por ejemplo, "(?" no se pueden validar ni publicar. Se obtiene un mensaje de error. Por ejemplo: 
    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