跳到主要内容

帮助 (help)

此模块负责 FAQ 列表、分类、搜索及帮助数据初始化。

无需登录，公开读取。

1. 获取 FAQ 列表 [GET]​

接口描述：获取帮助/FAQ 列表，可传分类等筛选。

项目说明
云函数名help
HTTP 路由不适用
动作类型 (Action)getFaqs

1.1 请求参数 (Parameters)​

参数名类型必选默认值描述示例
categoryIdString否-分类 ID“cat_xxx”
pageInteger否1页码1
pageSizeInteger否20每页条数20

1.2 响应数据 (Response)​

成功时返回 FAQ 列表，见 README 2.2 通用约定。

1.3 错误码 (Error Codes)​

见 通用报错码。

1.4 示例 (Examples)​

{
  "action": "getFaqs",
  "data": {}
}

2. 获取帮助分类 [GET]​

接口描述：获取帮助内容分类列表。

项目说明
云函数名help
HTTP 路由不适用
动作类型 (Action)getCategories

2.1 请求参数 (Parameters)​

无。

2.2 响应数据 (Response)​

见通用约定。

2.3 错误码 (Error Codes)​

见 通用报错码。

2.4 示例 (Examples)​

{
  "action": "getCategories",
  "data": {}
}

3. 搜索 FAQ [GET]​

接口描述：按关键词搜索 FAQ。

项目说明
云函数名help
HTTP 路由不适用
动作类型 (Action)searchFaqs

3.1 请求参数 (Parameters)​

参数名类型必选默认值描述示例
keywordString是-关键词“租期”

3.2 响应数据 (Response)​

见通用约定。

3.3 错误码 (Error Codes)​

见 通用报错码。

3.4 示例 (Examples)​

{
  "action": "searchFaqs",
  "data": { "keyword": "租期" }
}

4. 初始化帮助数据 [POST]​

接口描述：管理员或首次部署时初始化帮助/FAQ 数据。需管理员权限。

项目说明
云函数名help
HTTP 路由不适用
动作类型 (Action)initData

4.1 请求参数 (Parameters)​

见通用约定。

4.2 响应数据 (Response)​

见通用约定。

4.3 错误码 (Error Codes)​

见 通用报错码。

4.4 示例 (Examples)​

{
  "action": "initData",
  "data": {}
}