Skip to content

Commit 7c46742

Browse files
linwaiwailinwaiwai
authored
Update README.en-us.md
1 parent 64bd6aa commit 7c46742

1 file changed

Lines changed: 104 additions & 99 deletions

File tree

‎README.en-us.md‎

Lines changed: 104 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
English | [简体中文](./README.md)
1+
[简体中文](./README.md) | English
22

3-
<p align="center" >
4-
<a href="https://www.fizzgate.com"><img src="https://www.fizzgate.com/fizz/nav-bar/logo.png?v=1" width="70%"></a>
3+
<p align="center">
4+
<a href="https://www.fizzgate.com"><img src="https://www.fizzgate.com/fizz/nav-bar/logo.png?v=1" width="70%"></a>
55
</p>
6+
67
<p>
78
<img alt="Version" src="https://img.shields.io/badge/version-3.1.0-blue.svg?cacheSeconds=2592000" />
89
<a href="http://www.fizzgate.com/fizz-gateway-node/" target="_blank">
@@ -16,131 +17,130 @@ English | [简体中文](./README.md)
1617
</a>
1718
</p>
1819

19-
- **buissness and technology communication channel**:
20-
<img src="https://www.fizzgate.com/fizz/footer/serviceCode.png" width="150px">
21-
22-
## What 's FizzGate？
20+
> **Business or technical inquiries**:
21+
Please [purchase directly](https://l.fizzgate.com/#/shop/purchase) or [contact us](https://www.fizzgate.com/fizz/cms/article/about/contact/).
2322

24-
An Aggregation API Gateway in Java. FizzGate is a microservice aggregation gateway developed in Java, a domestic alternative for application gateways with independent intellectual property. It enables hot service orchestration aggregation, automatic authorization selection, online service script coding, online testing, high-performance routing, API audit management, callback management, etc. With a powerful custom plugin system, it can be extended and provides a friendly graphical configuration interface to help enterprises quickly implement API service governance, reduce middleware code, lower coding investment, and improve the stability and security of API services.
23+
**Note:** The community version is for testing only and does not include technical support. For commercial support, please contact us via WeCom (WeChat Work).
2524

25+
---
2626

27-
## Demo
27+
## What is FizzGate?
2828

29-
https://demo.fizzgate.com/
29+
**FizzGate** is a Java-based microservice aggregation gateway designed as a Chinese domestic alternative with full IP ownership. It enables real-time service orchestration, dynamic API aggregation, authorization management, scriptable API logic, online testing, high-performance routing, approval workflows, callback handling, and more.
3030

31-
In order to provide better services to everyone, the community version no longer provides any technical consultation. For the commercial version, please add Enterprise WeChat for business support.
31+
It features a powerful plugin system and an intuitive GUI for API governance, helping enterprises reduce glue code, streamline development, and improve API stability and security.
3232

33-
account/password:Please contact the official enterprise WeChat to obtain
33+
---
3434

35-
health checking url：https://demo.fizzgate.com/admin/health
35+
## Official Website
3636

37-
API access：https://demo.fizzgate.com/proxy/[Service Name]/[API Path]
37+
👉 https://www.fizzgate.com/
3838

39-
## Design Philosophy
39+
## Demo Environment
4040

41-
Intelligent interface, minimal dependencies, comprehensive features, and easy deployment. We strive for a simple and clear interface design, aiming to simplify complex configuration steps and operations to meet the needs of users at different levels. This enables developers, operations personnel, and others to efficiently manage and configure the system.
41+
👉 https://demo.fizzgate.com/
42+
Username / Password: *Commercial software. Trial accounts available via purchase or WeCom request.*
4243

43-
- Intelligent Interface: FizzGate focuses on intelligent design to enhance user experience. When users input data, the system will provide automatic input features whenever possible, reducing the complexity of user operations. Additionally, real-time prompts and reminders will be provided near the input area to assist users in configuring and operating the system quickly and accurately.
44-
- Minimal Dependencies: FizzGate is designed with careful consideration of external middleware and third-party dependencies, ensuring no intrusion into existing systems. Most features are based on self-developed technologies, minimizing the need for external dependencies, reducing resource consumption during deployment, while maintaining system efficiency and maintainability. This design makes FizzGate more stable and flexible for deployment within corporate networks.
45-
- Comprehensive Features: FizzGate covers the entire API lifecycle management, supporting various stages including API definition, integration, data masking, traceability, and security protection, thereby improving API management efficiency. As one of the most feature-rich products on the market, FizzGate offers a complete enterprise-level solution, helping companies achieve efficient and secure API management.
46-
- Easy Deployment: FizzGate has been designed with enterprise deployment requirements in mind, supporting disaster recovery needs for small and medium enterprises, as well as large-scale cluster deployments and geographically distributed deployments for larger enterprises. The deployment process is quick and simple, with deployment issues solved in less than a minute.
44+
- Health check: https://demo.fizzgate.com/admin/health (Restrict `/admin` path in production)
45+
- API access: https://demo.fizzgate.com/proxy/[service-name]/[api-path]
4746

48-
## Supported Architectures
47+
---
4948

50-
Supports arm64/amd64/x86/x86_64 architectures, compatible with Mac, Windows, and Linux, and supports Xinchuang components such as Kirin V10 and Dameng V8.
51-
52-
## FizzGate's Design
49+
## System Architecture
5350

5451
<img width="500" src="https://user-images.githubusercontent.com/184315/97130741-33a90d80-177d-11eb-8680-f589a36e44b3.png" />
5552

56-
## FizzGate's typical scene
57-
58-
<img width="90%" src="https://user-images.githubusercontent.com/6129661/216249866-71eb54de-d2e8-44ce-8e70-a1ca1f51553d.png" />
59-
60-
## Product Features
61-
62-
### API Management
63-
64-
- Application Management: Supports management of integrated applications.
65-
- API Management: Supports backend service configuration after API definition.
66-
- Group Management: Supports managing API-related configurations by grouping them.
67-
- Service Authentication: Through plugins, the service can apply access control, verification, and other chain interception strategies.
68-
- Cluster Management: FizzGate gateway nodes are stateless, with configuration information automatically synchronized. It supports horizontal scaling of nodes and multi-cluster deployment.
69-
- Security Authorization: Supports built-in authorization methods such as key-auth, JWT, and basic-auth, with easy control.
70-
- Load Balancing: Supports round-robin load balancing.
71-
- Circuit Breaker: Supports various recovery strategies and circuit breaker configurations based on services or specific addresses.
72-
- Multiple Registries: Supports service discovery from Eureka or Nacos.
73-
Configuration Center: Supports integration with Apollo configuration center.
74-
- HTTP Reverse Proxy: Hides real backend services and supports REST API reverse proxy.
75-
- Access Policies: Supports different access strategies for different APIs, with configurable authentication settings.
76-
- Blacklist/Whitelist: Supports configuring access restrictions via blacklists and whitelists.
77-
- Custom Plugins: A powerful plugin mechanism that allows for free expansion.
78-
- Extensible: The easy-to-use plugin mechanism facilitates function extension.
79-
- High Performance: Outstanding performance among numerous gateways.
80-
- Management Backend: Configures the gateway cluster through the management interface.
81-
- Replay Management: Supports management, subscription, replay, and logging of callbacks.
82-
- Multi-level Rate Limiting: Detailed rate-limiting methods, including service-level, interface-level, APP_ID-level, and IP-level rate limits.
83-
- Microservice Documentation: Enterprise-level management for open microservice documentation, simplifying system integration.
84-
- Public Network Dedicated Line: Establishes a fully protected private connection in the public network.
85-
- Transparent Proxy: Supports transparent proxy chaining.
86-
87-
### API Integration
88-
89-
- Service Orchestration: Supports hot service orchestration for HTTP, Dubbo, gRPC, and Soap protocols. Supports both frontend and backend encoding and JSON/XML output, allowing updates to the API anytime, anywhere.
90-
- Version Control: Supports the release of operations and multiple rollbacks.
91-
- Integration Testing: Provides API integration testing to ensure API interface reliability and availability.
92-
- Release Approval: Supports an approval process for API orchestration releases.
53+
---
9354

94-
### API Data Masking
55+
## Typical Use Cases
9556

96-
- Classification and Leveling: Supports the classification and hierarchical management of sensitive data, enabling reasonable masking strategies.
97-
- API Data Masking: Supports masking sensitive data in APIs, both structured and unstructured.
98-
- Masking Strategies: Supports visual masking strategy configurations, applying these strategies based on context.
99-
- Sensitive Data Recognition: Supports the identification of sensitive data in APIs.
100-
101-
### API Traceability
102-
103-
- Web File Watermark: Supports adding visible watermarks to proxy pages. Supports types such as HTML, Word/Excel/PPT/PDF, PNG/JPEG/TIFF, etc.
104-
- Leak Traceability: Supports tracing all contexts and terminal information of data queries related to leaks. Supports types such as JSON/HTML, Word/Excel/PPT/PDF, PNG/JPEG/TIFF, etc.
105-
106-
### API Security (Bypass Analysis)
57+
<img width="90%" src="https://user-images.githubusercontent.com/6129661/216249866-71eb54de-d2e8-44ce-8e70-a1ca1f51553d.png" />
10758

108-
- Asset Analysis: Analyzes and manages API security assets, generating API specifications to help detect potential security risks.
109-
- API Vulnerabilities: Scans and reports security vulnerabilities in API interfaces, improving API security.
110-
- API Anomalies: Supports anomaly detection for API access, enabling prompt response to abnormal behaviors.
111-
- API Blocking: Automatically or manually blocks API access upon detecting anomalies to prevent attack spread.
59+
---
11260

113-
## Benchmarks
61+
## Design Philosophy
11462

115-
We compare FzzGate with the major gateway products on the market, using the same environment and conditions, and the test objects are under single node. The Mock interface simulates a 20ms latency with a packet size of about 2K.
63+
- **Smart UI**: Contextual suggestions, auto-completion, and low-ops configuration.
64+
- **Minimal Dependencies**: Built-in core features with minimal 3rd-party reliance.
65+
- **Comprehensive Features**: Covers the full API lifecycle: from registration to security.
66+
- **Easy Deployment**: Supports standalone to cluster deployments, including failover and dual-active modes.
11667

117-
- Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz * 4
118-
- Linux version 3.10.0-957.21.3.el7.x86_64
119-
- 8G RAM
68+
---
12069

121-
| Category | Product name | QPS of <br/>600 connections | 90% Latency(ms) of <br/>600 connections | QPS of <br/>1000 connections | 90% Latency(ms) of <br/>1000 connections |
122-
| :------------------ | :------------------ | :-------: | :-------: | :-------: | :-------: |
123-
| Backend Service | direct access | 23540| 32.19 | 27325| 52.09 |
124-
| Traffic Gateway | kong <br/>v2.4.1 | 15662 | 50.87 | 17152 | 84.3 |
125-
| Application Gateway | fizz-gateway-node <br/>v3.5.1 | 12206 | 65.76 | 12766 | 100.34 |
126-
| Application Gateway | spring-cloud-gateway <br/>v2.2.9 | 11323 | 68.57 | 10472 | 127.59 |
127-
| Application Gateway | shenyu <br/>v2.3.0 | 9284 | 92.98 | 9939 | 148.61 |
70+
## Supported Architectures
12871

72+
- Compatible with `arm64`, `amd64`, `x86`, `x86_64`.
73+
- Runs on Mac, Windows, and Linux.
74+
- Supports China’s domestic secure platforms (Kylin V10, Dameng V8, etc.).
12975

130-
## Version comparison
76+
---
13177

132-
- fizz-gateway-node： Community Edition
78+
## Key Features
13379

134-
- fizz-manager-professional：Management backend professional version (backend)
80+
### API Management
81+
- App/API configuration
82+
- Request logging
83+
- Group-based configuration
84+
- Chain-based plugin authorization
85+
- Stateless node cluster with auto-sync
86+
- Built-in authentication: `Key-Auth`, `JWT`, `Basic-Auth`
87+
- Load balancing (round-robin)
88+
- Circuit breaker policies
89+
- Service discovery: `Eureka`, `Nacos`
90+
- Config center: `Apollo`
91+
- Reverse proxy
92+
- Access policy management
93+
- Black/white lists
94+
- Custom plugins
95+
- High performance
96+
- Management UI
97+
- Callback and replay support
98+
- Multi-level rate limiting (service/interface/app_id/IP)
99+
- API documentation
100+
- Private network tunneling
101+
- Transparent proxy support
135102

136-
- fizz-admin-professional：Management backend professional version (frontend)
103+
### API Integration
104+
- Supports HTTP, Dubbo, gRPC, SOAP orchestration
105+
- Supports JSON/XML transformation
106+
- Versioning & rollback
107+
- Integration testing
108+
- Approval workflow
109+
110+
### API Desensitization
111+
- Sensitive data classification and grading
112+
- Structured/unstructured desensitization
113+
- Visual strategy configuration
114+
- Sensitive data detection
137115

138-
| fizz-gateway-node | fizz-manager-professional | fizz-admin-professional |
139-
| ---------------------- | ------------------------- | ----------------------- |
140-
| v1.0.0 | v1.0.0 | v1.0.0 |
141-
| v1.1.0 | v1.1.0 | v1.1.0 |
142-
| v1.1.1 | v1.1.1 | v1.1.1 |
143-
| v1.2.0 | v1.2.0 | v1.2.0 |
116+
### API Traceability
117+
- Web watermarking for HTML/Word/Excel/PPT/PDF/Images
118+
- Leak traceability and contextual data history
119+
120+
### API Security (Out-of-Band Analysis)
121+
- API asset analysis and API spec generation
122+
- Sensitive data detection
123+
- Threat detection and response
124+
- Vulnerability scanning
125+
- Anomaly blocking (automatic/manual)
126+
127+
---
128+
129+
## Performance Benchmark
130+
131+
**Test Environment**
132+
- Intel Xeon E5-2650 v3 @ 2.30GHz ×4
133+
- Linux 3.10.0-957.21.3.el7.x86_64
134+
- 8GB RAM
135+
- Mock API with 20ms latency and 2KB payload
136+
137+
| Category | Product | QPS (600) | Latency P90 (600) | QPS (1000) | Latency P90 (1000) |
138+
|--------------|------------------------------|-----------|-------------------|-------------|---------------------|
139+
| Backend | Direct Access | 23540 | 32.19 ms | 27325 | 52.09 ms |
140+
| Traffic GW | Kong v2.4.1 | 15662 | 50.87 ms | 17152 | 84.3 ms |
141+
| App Gateway | FizzGate v3.0.0 | 12206 | 65.76 ms | 12766 | 100.34 ms |
142+
| App Gateway | Spring Cloud Gateway v2.2.9 | 11323 | 68.57 ms | 10472 | 127.59 ms |
143+
| App Gateway | ShenYu v2.3.0 | 9284 | 92.98 ms | 9939 | 148.61 ms |
144144

145145
Starting from v1.3.0, the frontend and backend of the management backend are merged into one package
146146

@@ -354,6 +354,10 @@ FizzGate官方技术交流③群：512164278
354354

355355
![aggr2](https://cdn.fizzgate.com/fizz/assets/img/manager_aggregate_add_9.662f119e.png)
356356

357+
![api_safety](https://cdn.fizzgate.com/safety/api_safety_home.png)
358+
359+
![api_safety_log](https://cdn.fizzgate.com/safety/api_safety_log.png)
360+
357361
![route](https://cdn.fizzgate.com/fizz/assets/img/route1.1fd8abd1.png)
358362

359363
![plugin](https://cdn.fizzgate.com/fizz/assets/img/manager_plugin_add_2.e1b5a24e.png)
@@ -365,3 +369,4 @@ FizzGate官方技术交流③群：512164278
365369
![flowcontrol](https://cdn.fizzgate.com/fizz/assets/img/manager_flow_control_rule_default_edit_2.130223a7.png)
366370

367371
![doc](https://cdn.fizzgate.com/fizz/assets/img/manager_interface_collection_preview_2.eee99e97.png)
372+

0 commit comments

Comments
 (0)