Skip to content

Commit 87248f4

Browse files
authored
Revert "docs: add gzip compression support for API responses to improve performance"
This reverts commit 24f18a7.
1 parent 2b14398 commit 87248f4

File tree

2 files changed

+0
-18
lines changed

2 files changed

+0
-18
lines changed

docs/en/api.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,6 @@ API Key authentication is enabled by default, automatically generated and saved
5555
- Authentication method: Add `X-API-Key: <key>` to request headers
5656
- Reset Key: PATCH `/instances/********`, body `{ "action": "restart" }`
5757

58-
### gzip Compression Support
59-
60-
NodePass API supports gzip compression to significantly reduce network traffic and improve response performance:
61-
62-
- Automatic Activation: Compression is automatically enabled when client sends `Accept-Encoding: gzip` request header
63-
- Universal Support: All API endpoint responses support gzip compression, including JSON data, HTML documents, and SSE event streams
64-
- Transparent Usage: Modern browsers and HTTP client libraries automatically handle compression and decompression
65-
- Performance Improvement: Typical JSON response compression ratios reach 60-80%, significantly reducing bandwidth usage
66-
6758
### Instance Data Structure
6859

6960
```json

docs/zh/api.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,6 @@ API Key 认证默认启用,首次启动自动生成并保存在 `nodepass.gob`
5555
- 认证方式:请求头加 `X-API-Key: <key>`
5656
- 重置 Key:PATCH `/instances/********`,body `{ "action": "restart" }`
5757

58-
### gzip 压缩支持
59-
60-
NodePass API 支持 gzip 压缩,可显著减少网络流量并提高响应性能:
61-
62-
- 自动启用:当客户端发送 `Accept-Encoding: gzip` 请求头时自动启用压缩
63-
- 全面支持:所有 API 端点响应内容均支持 gzip 压缩,包括 JSON 数据、HTML 文档和 SSE 事件流
64-
- 透明使用:现代浏览器和 HTTP 客户端库自动处理压缩和解压缩
65-
- 性能提升:典型的 JSON 响应压缩率可达 60-80%,显著降低带宽使用
66-
6758
### 实例数据结构
6859

6960
```json

0 commit comments

Comments
 (0)