Referencing the APIs for your Product
Detail the file paths for the APIs you want to include in your Product in IBM® API Connect.
About this task
Before an API can be included in a Plan, it must first be referenced in the APIs section of your Product description.
Begin the APIs section and reference the APIs you want to include in your Product. The syntax that you use depends on which user interface you are using, as follows:
- API Designer:
apis: API_1_NameAPI_1_Version $ref: API_1_File_Path API_2_NameAPI_2_Version $ref: API_2_File_Path
- API Manager:
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'where
- the API_n_Name variables are the case-sensitive names of your APIs.
- the API_n_Version variables are the versions of your APIs.
- the API_n_File_Path variables are the file paths for the YAML files containing OpenAPI representations of your APIs.
The following example shows a complete sample APIs section:
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'
For more information about creating OpenAPI definitions, see Creating an OpenAPI definition file.
The indentation must be as in the examples and the APIs must have been created before they can be referenced.
You have referenced the APIs that are to be included in your Product. An example of a complete YAML representation of a Product can be found in An example YAML representation of a Product.