📄️ Add Service Categories
Set optional category tags for APIs to allow team members to quickly find and use the needed APIs in the API marketplace.
📄️ Add Service
As a service provider, you need to first add a new service on the platform. When adding a service, fill in necessary information such as the service name and description. The service name should be clear and concise, and the description should include the main functions and purposes of the service.
📄️ Configure Upstream
The "upstream" refers to the backend server or service to which API requests are ultimately routed. The upstream usually contains the actual business logic, data storage, and applications that handle API requests. In an API gateway architecture, the gateway receives and processes requests from clients and then forwards these requests to the upstream server for handling, obtains responses, and returns them to the client.
📄️ Adding Routes
Routing refers to the process where the API Gateway forwards client requests to the appropriate backend services based on specific paths or conditions. The API Gateway is an intermediary layer located between the client and the server, used to manage, monitor, and route client API requests. Its routing capability is one of the core functionalities of the API Gateway.
📄️ Configure API (OpenAPI)
OpenAPI is a widely used specification for describing and documenting RESTful APIs. Initially known as Swagger, the OpenAPI Specification (OAS) provides a structured way to define an API's interface, including its endpoints, operations, requests, responses, and other related metadata. OpenAPI aims to simplify and standardize the design, development, documentation generation, and testing of APIs.
📄️ Service Configuration User Guide
To help subscribers understand and use the API, service providers need to configure detailed service usage instructions. Clear instructions can assist subscribers in getting started quickly and reduce issues encountered during use.
📄️ Release Version
Releasing a service version is a critical step in deploying the latest configured services and APIs to the production environment, ensuring that subscribers can access the latest released version of the APIs when making calls. By releasing a service version, you can unify the management of the lifecycle of APIs and services, ensuring that the latest configurations of services and APIs take effect timely, thus ensuring the system's stability and reliability.
📄️ Subscription Approval
Subscription approval in APIPark is the process by which service providers review and approve API service subscription requests submitted by subscribers. This process ensures that only authorized users can access specific API services, safeguarding system security and service quality.