JSON 转表格实战案例 - 文档编写 5 大场景（2026）

1
{
2
  "endpoint": "/api/users",
3
  "method": "POST",
4
  "parameters": [
5
    {
6
      "name": "username",
7
      "type": "string",
8
      "required": true,
9
      "description": "用户名，3-20 个字符"
10
    },
11
    {
12
      "name": "password",
13
      "type": "string",
14
      "required": true,
15
      "description": "密码，至少 8 个字符"
16
    },
17
    {
18
      "name": "email",
19
      "type": "string",
20
      "required": false,
21
      "description": "邮箱地址"
22
    }
23
  ]
24
}

1
## 创建用户
2

3
**接口**：`POST /api/users`
4

5
### 请求参数
6

7
| 参数 | 类型 | 必填 | 说明 |
8
|------|------|------|------|
9
| username | string | ✅ | 用户名，3-20 个字符 |
10
| password | string | ✅ | 密码，至少 8 个字符 |
11
| email | string | ❌ | 邮箱地址 |
12

13
### 示例
14

15
```json
16
{
17
  "username": "zhangsan",
18
  "password": "password123",
19
  "email": "zhangsan@example.com"
20
}

1
### 效果
2

3
- ✅ 文档清晰专业
4
- ✅ 参数一目了然
5
- ✅ 维护更新方便
6

7
---
8

9
## 案例 2：技术教程对比表
10

11
### 场景描述
12

13
**场景**：编写技术选型教程，对比不同方案
14

15
### JSON 数据
16

17
```json
18
{
19
  "comparison": "数据库选型",
20
  "options": [
21
    {
22
      "name": "MySQL",
23
      "type": "关系型",
24
      "strengths": "成熟稳定、生态完善",
25
      "weaknesses": "水平扩展困难",
26
      "useCases": "电商、金融系统"
27
    },
28
    {
29
      "name": "MongoDB",
30
      "type": "文档型",
31
      "strengths": "灵活 schema、易扩展",
32
      "weaknesses": "不支持事务（旧版本）",
33
      "useCases": "内容管理、日志系统"
34
    }
35
  ]
36
}

1
<table class="comparison-table">
2
  <thead>
3
    <tr>
4
      <th>功能</th>
5
      <th>免费版</th>
6
      <th>专业版</th>
7
      <th>企业版</th>
8
    </tr>
9
  </thead>
10
  <tbody>
11
    <tr>
12
      <td>用户数</td>
13
      <td>5</td>
14
      <td>50</td>
15
      <td>无限</td>
16
    </tr>
17
    <tr>
18
      <td>存储</td>
19
      <td>1GB</td>
20
      <td>10GB</td>
21
      <td>100GB</td>
22
    </tr>
23
    <tr>
24
      <td>价格</td>
25
      <td>免费</td>
26
      <td>$99/月</td>
27
      <td>定制</td>
28
    </tr>
29
  </tbody>
30
</table>

1
.comparison-table {
2
  width: 100%;
3
  border-collapse: collapse;
4
  margin: 30px 0;
5
}
6

7
.comparison-table th {
8
  background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
9
  color: white;
10
  padding: 15px;
11
}
12

13
.comparison-table td {
14
  padding: 12px;
15
  text-align: center;
16
  border-bottom: 1px solid #ddd;
17
}
18

19
.comparison-table tr:hover {
20
  background-color: #f5f5f5;
21
}

1
# 2026 年 1 月经营分析
2

3
## 核心指标
4

5
| 指标 | 数值 | 环比增长 |
6
|------|------|----------|
7
| 总收入 | ¥1,000,000 | +15.5% |
8
| 新用户 | 5,000 | +8.2% |
9
| 活跃用户 | 50,000 | +5.1% |
10
| 订单数 | 10,000 | +12.3% |
11

12
## 分析总结
13

14
- 总收入增长强劲，超预期完成目标
15
- 新用户增长稳定，获客成本下降
16
- 活跃用户增速放缓，需加强运营

1
== 常见问题 ==
2

3
{| class="wikitable"
4
|-
5
! 问题 !! 原因 !! 解决方案
6
|-
7
| 登录失败 || 密码错误 || 重置密码
8
|-
9
| 页面加载慢 || 网络问题 || 检查网络连接
10
|-
11
| 数据不同步 || 缓存问题 || 清除缓存
12
|}
13

14
== 联系方式 ==
15

16
{| class="wikitable"
17
|-
18
! 部门 !! 邮箱 !! 电话
19
|-
20
| 技术支持 || support@company.com || 400-123-4567
21
|-
22
| 销售咨询 || sales@company.com || 400-765-4321
23
|}