Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 5.03 KB

README_EN.md

File metadata and controls

77 lines (52 loc) · 5.03 KB

img

license PRs Welcome

简体中文 | English

Overview

BlueKing API Gateway is a high-performance and highly available API hosting service that helps developers create, publish, maintain, monitor, and protect APIs, allowing for quick, low-cost, and low-risk access to data or services from BlueKing applications or other systems.

The BlueKing API Gateway is divided into the control plane and the data plane. The control plane is responsible for functions such as API configuration, publishing, monitoring, and permission management. The data plane handles API traffic forwarding, security protection, and other functions. The data plane is built on Apache APISIX with a series of additional plugins to support the features of the BlueKing API Gateway. Thanks to the dynamic, real-time, and high-performance characteristics of Apache APISIX, the BlueKing API Gateway can support high-concurrency and low-latency API services.

This project is the "BlueKing API Gateway - Control Plane".

BlueKing API Gateway Core Services Open Source Projects

  • BlueKing API Gateway - Control Plane
    • dashboard: Control plane for the API gateway
    • dashboard-front: Frontend for the API gateway control plane
    • core-api: Gateway high performance core API
    • esb: ESB component service
  • BlueKing API Gateway - Data Plane
  • BlueKing API Gateway - Operator

Features

  • API lifecycle management: covering the management of API configuration, release, testing, monitoring, and deactivation throughout the entire lifecycle.
  • Version release: supporting multi-environment management where users can create new environments to meet the needs of development, testing, and production; providing API version management where each environment can switch versions with just one click without affecting each other.
  • Documentation and SDK: providing online documentation and an SDK for calling the gateway API, reducing the threshold for using the API.
  • Authorization management: default authorization restrictions are enabled, supporting authorization expiration and authorization dimensions.
  • Security protection: supporting BlueKing application authentication, user authentication, controlling the source of requests; supporting IP access control, where IP blacklist/whitelist can be set; supporting second-level traffic control, traffic allocation can be made according to demand, to avoid backend service overload caused by high traffic; supporting operation auditing.
  • Observability: supporting call flow query; supporting integration with OpenTelemetry; built-in various alert strategies.

Getting started

Support

img

BlueKing Community

  • BK-CI: a continuous integration and continuous delivery system that can easily present your R & D process to you.
  • BK-BCS: a basic container service platform which provides orchestration and management for micro-service business.
  • BK-SOPS: an lightweight scheduling SaaS for task flow scheduling and execution through a visual graphical interface.
  • BK-CMDB: an enterprise-level configuration management platform for assets and applications.
  • BK-JOB: BlueKing JOB is a set of operation and maintenance script management platform with the ability to handle a large number of tasks concurrently.

Contributing

If you have good ideas or suggestions, please let us know by Issues or Pull Requests and contribute to the Blue Whale Open Source Community. For blueking-apigateway branch management, issues, and pr specifications, read the CONTRIBUTING(In Chinese)

If you are interested in contributing, check out the [CONTRIBUTING.md], also join our Tencent OpenSource Plan.

Partners

APISIX logo

License

blueking-apigateway is based on the MIT protocol. Please refer to LICENSE