Publish an API¶
API Publishing is the process of making a created API visible in the DevPortal and available for subscription. An API that is in the CREATED state of the lifecycle will have the API metadata added to the DevPortal, but not deployed to the API Gateway. Therefore, it will not be visible to subscribers in the DevPortal. When the API is published, it gets deployed on the API Gateway, and the API lifecycle state changes to PUBLISHED.
Follow the steps below to publish an API:
Sign in to WSO2 API Cloud by providing your username and password. This opens the API Publisher portal where you will see the list of created APIs. If you have not created an API yet, follow the steps here to design a new REST API.
Click on an API that is in the CREATED state.
Click Lifecycle. This displays the lifecycle state transition grid.
- Before you publish the API, be sure that you satisfy the following requirements:
- Specify an endpoint URL
- Select business plan(s)
If any of the above requirements are not satisfied, it is indicated in the lifecycle page and you have to navigate to the relevant sections and provide the missing information such as endpoint URL and business plans.
If required, you can select the following options when publishing an API.
- Require re-subscription when publish the API : If selected, it invalidates the current user subscriptions and forces the users to subscribe again.
- Deprecate old versions after publish the API : If selected, all prior versions of the API that are published will be set to the DEPRECATED state automatically.
If the API is published successfully, the lifecycle state should change to PUBLISHED.
You can also navigate to the DevPortal and check whether the API that you published is visible under the APIs listing.Top