User Manual
Key Functionalities
The API Gateway offers the following core functionalities:
- Create and update downstream services based on Swagger/OpenAPI documentation.
- Delete obsolete downstream services.
- Create upstream APIs/endpoints:
- Manually
- Based on downstream endpoints/services
- Configure/edit upstream APIs/endpoints, including:
- Basic settings
- Mapping
- Processing
- Activate, deactivate, and delete upstream APIs/endpoints
- Monitor activated services
- Explore endpoint definitions, mappings, processing, and load balancing settings
- Export and import API Gateway configurations for transfer between servers
API Development Workflow
- Import Backend Service Definitions:
- Use the Services dialog to import backend service definitions as downstream endpoints.
- Create Upstream Endpoints:
- Use the APIs dialog to expose downstream services via the API Gateway.
- Configure Mapping and Processing:
- Optionally, configure mapping and processing for advanced scenarios. See Processing and Mapping.
- Export/Import Configurations:
- Use the Export and Import functionality to transfer configurations between servers.
Example: Swagger Petstore
The examples in this manual use the Swagger Petstore API as a reference backend service. Please note that this API is for demonstration purposes and may not be accessible in your production environment.
For all configuration and operational details, refer to the respective dialog sections in this manual.