Creación de un archivo de definición OpenAPI

Las API se definen en los archivos de definición de OpenAPI , en formato YAML. Puede crear un archivo de definición OpenAPI predeterminado utilizando el mandato create y, a continuación, modificarlo utilizando un editor de su elección.

Puede poner en escena o publicar la API directamente en un catálogo en el Gestor de API haciendo referencia a la API en un archivo de definición de Producto y, a continuación, utilizando el comando apic products:publish para publicar el Producto. También puede crear un borrador de API en Gestor de API utilizando el mandato apic draft-apis:create .

Puede crear una API en la CLI ejecutando apic create:api, y proporcionando argumentos adicionales en la línea de comandos.

Otra opción es crear una API de forma interactiva en la línea de mandatos ejecutando apic create:api y siguiendo las indicaciones.

Puede ver más detalles y opciones disponibles para el mandato apic create:api ejecutando:

apic create:api --help

IBM proporciona una extensión a la especificación OpenAPI ; esta extensión se describe en ExtensionesIBM a la especificación OpenAPI.

Nota: Los productos que contienen una API con una propiedad Swagger utilizando regex que incluyen aserciones de búsqueda anticipada, como "(?", 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

Creación de una definición de API a partir de una plantilla

Puede utilizar una plantilla de Barra de descriptor de contexto personalizada para crear una API mediante el mandato siguiente:

apic create:api --template template_filename --title api_title

donde nombre_archivo_plantilla es el nombre de la plantilla de Barra de descriptor de contexto a utilizar y título_api es el título de la API.

Un archivo de plantilla de API debe tener una extensión de nombre de archivo .hbs. Puede crear una plantilla desde cero o empezar con la plantilla de API de ejemplo (predeterminada) que se proporciona en los ejemplos de plantillas de definición de API y Producto.

Puede crear documentación de producto y API multilingüe utilizando una extensión x-ibm-languages directamente en la definición de OpenAPI . Para obtener más información, consulte Utilización de x-ibm-languages para crear API multilingüe y documentación del producto.