Staging an API
The graphical wizard provides an option that adds the API to a Product and stages the Product in a Catalog. When a Product is in the staged state, it is not yet visible to, or subscribable by, any developers. The syndication feature in IBM® API Connect means that if Spaces are enabled for a Catalog, Products can be staged only to a Space within that Catalog.
Before you begin
Ensure that you have a Catalog to stage to in the API Manager or API Designer user interfaces (UI). For more information, see Creating and configuring Catalogs.
Ensure that the Catalog has at least one gateway service configured.
To complete the Product management tasks that are described in this topic, you must either be the owner of the API provider organization, or be assigned Product > Stage permission for the target Catalog or Space. For information on configuring Product management permissions for a Catalog or Space, see Creating and configuring Catalogs or Managing user access in a Space.
About this task
You can complete this task either by using either the API Designer UI application, or by using the browser based API Manager UI. Staging is not available when working offline in API Designer.
A Catalog is a staging target, and behaves as a logical partition of the DataPower® Gateway, and the Developer Portal.
- Validation against the OpenAPI specification schema
- Validation against IBM extension properties
- Semantic validation, which includes the following types of validation:
- Ensuring that if an API is enforced by an API Connect
Gateway, then the
scheme must be HTTPS, or the parameter name for an API key security scheme in the header must be
either
X-IBM-Client-Id
orX-IBM-Client-Secret
. - Ensuring that if the API is not enforced by an API Connect
Gateway, then a
host
must be provided
- Ensuring that if an API is enforced by an API Connect
Gateway, then the
scheme must be HTTPS, or the parameter name for an API key security scheme in the header must be
either
$ref
field to reference a fragment of OpenAPI code that is defined
in a separate file, the $ref
field is replaced
with the contents of the target file before the product that contains the API is staged or published
(the $ref
field is supported only if you are using the API Connect for IBM Cloud
developer toolkit). For more information, see Using $ref to
reuse code fragments in your OpenAPI
files.Procedure
Results
Your Product is staged to a Catalog. You can view the state of the Product in the Catalog in API Manager. If you staged the product from API Designer, ensure you are logged into API Manager with the same user name and password that you used for API Designer. Click Manage in the API Manager UI, then select the required Catalog. The Product is shown with a state of Staged.
For information about the lifecycle of a product, see The Product lifecycle.
If approval is required to stage Products in the Catalog, an approval request is sent, and the Product moves to the Pending state; the Product is staged when the request is approved. If approval is not required, the Product is staged immediately.
For information on configuring Product lifecycle approvals for a Catalog, see Creating and configuring Catalogs. For information on approving requests, see Approving Product lifecycle and subscription requests.