# mm API 文档生成指南

## 规则（Rules）

- API 文档根据 `api.json` 配置自动生成，无需手动编写
- 文档包含接口路径、请求方法、参数列表、返回值说明
- 文档的完整性取决于 api.json 中各个描述字段的填写质量

## 方法（Methods）

### 步骤1：完善 api.json 描述信息

确保以下字段填写完整：

```json
{
    "path": "/api/my_api",
    "name": "api_my_api",
    "title": "我的接口",
    "description": "该接口用于查询用户信息，传入用户ID返回昵称和头像",
    "method": "ALL",
    "scope": true
}
```

关键字段：`title`（接口名称）、`description`（接口说明）

### 步骤2：完善参数校验文档

在 `param.json` 中为每个参数写上 `title`：

```json
"list": [{
    "name": "user_id",
    "title": "用户ID",
    "type": "number",
    "number": { "range": [1, 99999] }
}]
```

### 步骤3：查看文档

启动服务后，通过管理后台访问接口文档入口，自动生成所有 `scope: true` 的接口文档。

## 技巧（Tips）

- `scope: true` 的接口在文档中公开显示，`scope: false` 则隐藏
- `description` 字段内容越详细，文档越有价值
- `param.json` 中的 `title` 和 `type` 会自动体现在文档的参数列表中
- 文档随 API 配置自动更新，无需手动维护