Service Management

The Service Management module allows teams to create and manage multiple services, with each service able to bind multiple APIs. Users can showcase services in the Service Plaza for subscribers to subscribe to as needed. After a subscription application is submitted, it requires administrator approval, and once approved, subscribers can access all APIs under that service. Through this module, teams can manage and publish APIs flexibly, and subscribers can conveniently access the required services, enhancing API usage efficiency and team collaboration capabilities.

tip

Services displayed in the Service Plaza must meet the following conditions:

• The service type is external service;
• The service contains APIs; if none exist, please refer to the tutorial Add API;
• The service has an upstream configured; if not configured, please refer to the tutorial Configure Upstream;
• The service is published; if not published, please refer to the tutorial Release Version.

Operation Demonstration

Add Service

1. Click Workspace -> My -> Service to enter the service list page and then click Add Service.

2. Enter the service information in the popup form.

Field Description

Field Name	Description
Service Name	The name used to identify and describe the service.
Service ID	The Service ID is used to uniquely identify the service, ensuring accurate differentiation between different services during management and operations. It is used internally and during invocation and is difficult to change.
API Call Prefix	The URL prefix used when calling the API of the service. It is used to manage and route API requests uniformly, ensuring requests are correctly directed to the target service. The prefix should be associated with the service name and easy to remember and use.
Description	Records and displays detailed information and function description of the service.
Responsible Team	The team responsible for managing and maintaining the service.
Icon	This icon will be displayed in the Service Plaza.
Tags	Custom tags for the service to facilitate quick searching by subscribers.
Service Type	If it's an External Service, subscribers can obtain and apply for subscriptions through the Service Plaza. Once approved by the provider, calls can be initiated. If it's an Internal Service, call permissions can only be allocated by the provider through distribution to subscribers.
Service Category	Select the service category that will be displayed in the Service Plaza.

Here, we choose External Service as the service type and select the Service Category. Once completed, click Submit.

If there is no service category, please refer to the tutorial Add Service Category.

Edit Service Information

1. Select the service you want to edit and click to enter the service details page.

2. Click Settings to enter the service settings page.

3. After modifying, click Save.

Edit Service Description

tip

If the service is an external service and is published, this service description will be displayed in the API market's service details and updated in real-time.

Once you enter the service page, click on Usage Instructions and fill in the service usage guide information.

After editing, click save to finish.

Delete Service

1. After entering the service settings page, click Delete Service at the bottom.

2. In the popup box, click Confirm.