Publish an API

API Publishing is the process of making the API visible in the Developer Portal and available for subscription. An API in the lifecycle state CREATED will have the  API metadata added to the Developer Portal, but not deployed to the API Gateway. Therefore, it is not visible to subscribers in the Developer Portal. When the API is published, it gets deployed on the API Gateway, and the API lifecycle state will be changed to PUBLISHED.

Follow the steps below to publish an API using WSO2 API Manager.

  1. Sign in to the API Publisher https://<hostname>:9443/publisher (e.g., https://localhost:9443/publisher ). Upon signing in, the list of APIs in the API Publisher is listed. Please refer create an API guide to create a new API.

    The list of APIs in the API Publisher appears. If there are no APIs created, create an API before starting.

  2. Click on an API that is in the CREATED state.

    Select API

  3. Click Lifecycle.

    Lifecycle tab

    The lifecycle state transition grid appears. Before publishing an API, the following requirements have to be satisfied.publish-through-multiple-api-gateways.md

    -   Endpoint provided
-   Business Plan(s) selected

    If any of the above requirements are not satisfied, it is indicated in the lifecycle page, and you need to navigate to relevant sections and provide the missing information such as endpoint URL and business plans.

    Publish API requirements

  4. If the latter mentioned requirements are satisfied, click PUBLISH to push the API.

    If required, you can select the following options when publishing the 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.

    Publish API

    If the API is published successfully, the lifecycle state will shift to PUBLISHED.

    Published lifecycle state

  5. Nagivate to the Developer Portal (https://<hostname>:9443/devportal).

    Note that the API that you published is visible under the APIs listing.

Top