Tutorial: Staging and publishing a project from the API Designer
This tutorial shows you how to stage and publish a project using the API Designer in IBM® API Connect Version 5.0.7 and later. Staging a project copies all the files to the target, but does not run the project application code. Publishing a project copies all the project files to the target and runs the project application code. You publish a LoopBack® project to make its APIs available to application developers through the Developer Portal.
Before you begin
Before you begin, you must install the developer toolkit on your local machine. For details, see Installing the toolkit.
To stage or publish to API Connect collective, you must install and configure an API Connect collective. You must add a Collective and a Collective controller by using the Cloud Manager. See Installing an API Connect collective.
- You must be the owner of a provider organization, or have been added to a provider organization as a user with the Publisher role. For details on creating a provider organization and specifying the owner, see Creating a provider organization account. For details on adding a user to a provider organization with the Publisher role, see Adding users and assigning roles.
- You must have followed the instructions in the provider organization email invitation to activate your API Connect account.
You must also do the following:
About this tutorial
In this tutorial, you will stage and publish a LoopBack project to an API Connect collective from the API Designer.
Publishing a project to an API Connect collective
Staged /Users/john/acme-bank/definitions/acme-bank-product.yaml to climbon:sb [acme-bank:1.0.0]
Published /Users/john/acme-bank/definitions/acme-bank-product.yaml to climbon:sb [acme-bank:1.0.0]
Successfully published products
...building package for deploy
Creating keys...this may take some time
...uploading packages to 169.53.159.240:9443, scale: 1
Upload successful: acme-bank-57057c0ee4b011906e320bda-1459977334690-package.tgz
Upload successful: acme-bank-57057c0ee4b011906e320bda-1459977334690.deploy.xml
Upload successful: apic.acme-bank-57057c0ee4b011906e320bda-1459977334690.scalingPolicy.xml
Upload to liberty server completed succesfully.
Applications may take a few minutes to update and start.
Once the project is published, the API Designer displays a Success message.
If you want to confirm that the application was published in your API Connect collective, you can connect to the Liberty Admin Center by clicking Manage this app from within your App in the API Manager.
What you did in this tutorial
In this tutorial, you published a project to an API Connect collective by using the API Designer.
What to do next
If you want to use an application with a DataPower® Gateway, configure your collective and gateway and then modify your assembly. For more information, see Configuring your DataPower Gateway and API Connect collective controller to communicate and Modifying the assembly to call an application endpoint hosted on a collective.