Publishing API to API7 Developer Portal

This article will guide you, as an API provider, on how to publish an API to the developer portal. This will allow internal or external developers to log in and find this API, view its documentation, and apply for API subscriptions to obtain access credentials upon approval by the API provider or administrator.

Now, we want to publish the CreateProduct API we created before to the developer portal, allowing developers to apply for the required API key themselves.

Prerequisites

1. Building Developer Portal Site
2. Prepare the OpenAPI Spec file, including detailed API usage instructions and descriptions.
3. Publishing APIs to API7 Gateway, and then Enabling API Authentication.

Add API

Refer to the documentation on Adding an API.

In 5. Fill in the form, select CreateProduct for the associated route. Since the route has already enabled the key-auth plugin, the developer portal will automatically recognize this authentication method.

In 5. Fill in the form, upload the corresponding OpenAPI Spec file.

Validate

Backend API Verification

Call the "Get All Published API List" API, where you can see that it includes CreateProduct.

Console Display Verification

Log in to the established open platform website, and you will be able to find CreateProduct.