Hacer referencia a las APIs del producto

Detalle las vías de acceso de archivo para las API que desea incluir en el producto en IBM® API Connect.

Acerca de esta tarea

Para poder incluir una API en un plan, primero hay que referenciarla en la sección de APIs de la descripción del producto.

Procedimiento

Inicie la sección de APIs y haga referencia a las API que desea incluir en el producto. La sintaxis que utilice dependerá de la interfaz de usuario que esté utilizando, como se indica a continuación:
  • Diseñador de API:
    apis:
      API_1_NameAPI_1_Version
        $ref: API_1_File_Path
      API_2_NameAPI_2_Version
        $ref: API_2_File_Path
  • Gestor de API:
    apis:
      API_1_NameAPI_1_Version
        name: 'API_1_Name:API_1_Version'
      API_2_NameAPI_2_Version
        name: 'API_2_Name:API_2_Version'
    donde
    • las variables Nombre_API_n son los nombres que distinguen entre mayúsculas y minúsculas de las APIs.
    • Las variables versión_API_n son las versiones de las APIs.
    • Las variables API_n_File_Path son las vías de acceso de archivo para los archivos YAML que contienen representaciones OpenAPI de las API.
El ejemplo siguiente muestra una sección completa de APIs de ejemplo:
apis:
  api11.0.0:
    name: 'api1:1.0.0'
  api21.0.0:
    name: 'api2:1.0.0'
  api31.0.0:
    name: 'api3:1.0.0'

Para obtener más información sobre cómo crear definiciones de « OpenAPI », consulte «Creación de un archivo de definiciones de OpenAPI ».

La sangría debe ser como en los ejemplos y las APIs deben haberse creado para poder referenciarlas.

Resultados

Ha hecho referencia a las API que se van a incluir en el producto. Se puede encontrar un ejemplo de una representación YAML completa de un producto en «Un ejemplo de representación YAML de un producto ».