Hooke / manulife-weapp

Go to a project
Toggle navigation Toggle navigation pinning
hookehuyr
a4ef54a9 1 parent 2b004952

docs(api): 同步搜索 API 文档，将 file 类型改为 article 

- 更新搜索 API 响应字段：files → article
- 字段名规范化：name/value/extension → post_title/post_excerpt/post_link
- 文章详情 API 添加 file_list 字段类型定义
- 计划书 API 完善参数文档说明

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Inline Side-by-side
Showing 4 changed files with 50 additions and 133 deletions
......@@ -44,7 +44,7 @@ paths:
type: string
- name: type
in: query
description: product=产品，file=文档
description: product=产品，article=文章
required: false
schema:
type: string
......@@ -155,7 +155,7 @@ paths:
- list
- total
title: 产品列表
files:
article:
type: object
properties:
list:
......@@ -165,61 +165,50 @@ paths:
properties:
id:
type: integer
title: 附件id
name:
type: string
title: 附件名
value:
post_title:
type: string
title: 附件地址
extension:
title: 文章标题
post_excerpt:
type: 'null'
title: 文章简介
post_link:
type: string
title: 附件类型
post_date:
type: string
title: 发布时间
size:
type: string
title: 附件大小
title: 发布日期
is_favorite:
type: integer
title: 是否收藏
type:
type: string
required:
- id
- name
- value
- extension
- post_title
- post_excerpt
- post_link
- post_date
- size
- is_favorite
- type
x-apifox-orders:
- id
- name
- value
- extension
- post_title
- post_excerpt
- post_link
- post_date
- size
- is_favorite
- type
total:
type: integer
title: 附件数
title: 总数
required:
- list
- total
x-apifox-orders:
- list
- total
title: 文件列表
title: 文章列表
required:
- products
- files
- article
x-apifox-orders:
- products
- files
- article
required:
- code
- msg
......@@ -228,96 +217,7 @@ paths:
- code
- msg
- data
example: |-
{
"code": 1,
"msg": 0,
"data": {
"products": {
"list": [
{
"id": 2769848,
"product_name": "1111",
"product_description": "<p>5564</p>\r\n<p>hdye</p>",
"recommend": "normal",
"created_time": "2026-02-02 16:33:01",
"cover_image": "https://cdn.ipadbiz.cn/space_30901/申请提交-生成计划书_FvdRVOS0K-Wmp05ZKHpx64sEXcKQ.png",
"tags": [
{
"id": "2769846",
"name": "测试1",
"bg_color": "#1e9fff",
"text_color": "#ffffff"
},
{
"id": "2769847",
"name": "111",
"bg_color": "#3e5160",
"text_color": "#ffffff"
}
],
"type": "product"
},
{
"id": 2769845,
"product_name": "1",
"product_description": null,
"recommend": "normal",
"created_time": "2026-02-02 16:22:26",
"cover_image": null,
"tags": [],
"type": "product"
}
],
"total": 2,
},
"files": {
"list": [
{
"id": 2769815,
"name": "9751dd823b7542d78fa7bde615a43ba1",
"value": "https://cdn.ipadbiz.cn/space_30901/9751dd823b7542d78fa7bde615a43ba1_Fsm43FPaZOwKc5pwbxhk-h2zUUsu.png",
"extension": "png",
"post_date": "2026-01-13 11:26:07",
"size": "0 B",
"is_favorite": 0,
"type": "file"
},
{
"id": 2769814,
"name": "微信图片_2026-01-12_173653_750",
"value": "https://cdn.ipadbiz.cn/space_30901/微信图片_2026-01-12_173653_750_Fuu11vu9Zp5B626kEbWE62vQLeA7.png",
"extension": "png",
"post_date": "2026-01-13 11:26:07",
"size": "0 B",
"is_favorite": 0,
"type": "file"
},
{
"id": 2769811,
"name": "微信图片_2026-01-12_173913_253",
"value": "https://cdn.ipadbiz.cn/space_30901/微信图片_2026-01-12_173913_253_FoQoABNxtf4dB2vKLD-Eke8Tsgu5.png",
"extension": "png",
"post_date": "2026-01-13 11:25:47",
"size": "0 B",
"is_favorite": 0,
"type": "file"
},
{
"id": 2768696,
"name": "123222",
"value": "https://cdn.ipadbiz.cn/space/30901/4c2ab735c6996a89d7c423bf428a1748.png",
"extension": "png",
"post_date": "2025-10-30 18:30:28",
"size": "0 B",
"is_favorite": 0,
"type": "file"
}
],
"total": 4,
}
}
}
example: "{\n \"code\": 1,\n \"msg\": 0,\n \"data\": {\n \"products\": {\n \"list\": [\n {\n \"id\": 2769848,\n \"product_name\": \"1111\",\n \"product_description\": \"<p>5564</p>\\r\\n<p>hdye</p>\",\n \"recommend\": \"normal\",\n \"created_time\": \"2026-02-02 16:33:01\",\n \"cover_image\": \"https://cdn.ipadbiz.cn/space_30901/申请提交-生成计划书_FvdRVOS0K-Wmp05ZKHpx64sEXcKQ.png\",\n \"tags\": [\n {\n \"id\": \"2769846\",\n \"name\": \"测试1\",\n \"bg_color\": \"#1e9fff\",\n \"text_color\": \"#ffffff\"\n },\n {\n \"id\": \"2769847\",\n \"name\": \"111\",\n \"bg_color\": \"#3e5160\",\n \"text_color\": \"#ffffff\"\n }\n ],\n \"type\": \"product\"\n },\n {\n \"id\": 2769845,\n \"product_name\": \"1\",\n \"product_description\": null,\n \"recommend\": \"normal\",\n \"created_time\": \"2026-02-02 16:22:26\",\n \"cover_image\": null,\n \"tags\": [],\n \"type\": \"product\"\n }\n ],\n \"total\": 2,\n },\n \"article\": {\n \"list\": [\n {\n \"id\": 3187833,\n \"post_title\": \"宏利電匯付款指引\",\n \"post_excerpt\": null,\n \"post_link\": \"\",\n \"post_date\": \"2026-02-28 13:50:03\",\n \"open_num\": null,\n \"file_sn\": null,\n \"is_favorite\": 0,\n \"type\": \"article\"\n },\n {\n \"id\": 3187734,\n \"post_title\": \"Miracle团队完成宏利新产品《牌照專業資格》指引\",\n \"post_excerpt\": null,\n \"post_link\": \"\",\n \"post_date\": \"2026-02-28 11:33:32\",\n \"open_num\": null,\n \"file_sn\": null,\n \"is_favorite\": 0,\n \"type\": \"article\"\n },\n {\n \"id\": 3187715,\n \"post_title\": \"为准招募报名IIQE考试指引\",\n \"post_excerpt\": null,\n \"post_link\": \"\",\n \"post_date\": \"2026-02-28 11:10:20\",\n \"open_num\": null,\n \"file_sn\": null,\n \"is_favorite\": 1,\n \"type\": \"article\"\n },\n {\n \"id\": 3185818,\n \"post_title\": \"TTPS、IANG续签指引\",\n \"post_excerpt\": null,\n \"post_link\": \"\",\n \"post_date\": \"2026-02-26 14:30:40\",\n \"open_num\": null,\n \"file_sn\": null,\n \"is_favorite\": 0,\n \"type\": \"article\"\n },\n {\n \"id\": 3185673,\n \"post_title\": \"CEO\_Profile入职指引\",\n \"post_excerpt\": null,\n \"post_link\": \"\",\n \"post_date\": \"2026-02-26 14:07:32\",\n \"open_num\": null,\n \"file_sn\": null,\n \"is_favorite\": 0,\n \"type\": \"article\"\n },\n {\n \"id\": 3185672,\n \"post_title\": \"Millionaire\_Profile入职指引\",\n \"post_excerpt\": null,\n \"post_link\": \"\",\n \"post_date\": \"2026-02-26 14:04:50\",\n \"open_num\": null,\n \"file_sn\": null,\n \"is_favorite\": 0,\n \"type\": \"article\"\n },\n {\n \"id\": 3185667,\n \"post_title\": \"IANG Profile入职指引\",\n \"post_excerpt\": null,\n \"post_link\": \"\",\n \"post_date\": \"2026-02-26 13:44:30\",\n \"open_num\": null,\n \"file_sn\": null,\n \"is_favorite\": 0,\n \"type\": \"article\"\n }\n ],\n \"total\": 7\n }\n }\n}\n"
headers: {}
x-apifox-name: 成功
x-apifox-ordering: 0
......
......@@ -24,9 +24,28 @@ const Api = {
post_date: string; // 发布日期
post_author: integer; // 发布人id
author_name: string; // 发布人
file_list: {
icon: {
meta_type: string; //
id: integer; //
object_id: null; //
name: string; //
value: string; //
description: null; //
extension: string; //
post_date: string; //
icon: null; //
master_client_id: null; //
hash: string; //
height: string; //
width: string; //
author: integer; //
size: null; //
};
};
is_favorite: integer; //
* };
* } >}
* }>}
*/
export const articleDetailAPI = (params) => fn(fetch.get(Api.ArticleDetail, params));
......
......@@ -13,8 +13,8 @@ const Api = {
* @param {Object} params 请求参数
* @param {string} params.customer_name 申请人
* @param {string} params.customer_gender 性别
* @param {integer} params.customer_age 年龄
* @param {string} params.customer_birthday 出生年月日
* @param {integer} params.customer_age (可选) 与 customer_birthday 二选一，至少提供一个
* @param {string} params.customer_birthday (可选) 与 customer_age 二选一，至少提供一个。格式：YYYY-MM-DD
* @param {integer} params.annual_premium 保额
* @param {string} params.payment_years 繳費年期
* @param {string} params.currency_type 币种
......
......@@ -9,7 +9,7 @@ const Api = {
* @remark
* @param {Object} params 请求参数
* @param {string} params.keyword (可选)
* @param {string} params.type (可选) product=产品，file=文档
* @param {string} params.type (可选) product=产品，article=文章
* @returns {Promise<{
* code: number; // 状态码
* msg: string; // 消息
......@@ -33,18 +33,16 @@ const Api = {
}>;
total: integer; // 产品总数
};
files: {
article: {
list: Array<{
id: integer; // 附件id
name: string; // 附件名
value: string; // 附件地址
extension: string; // 附件类型
post_date: string; // 发布时间
size: string; // 附件大小
id: integer; //
post_title: string; // 文章标题
post_excerpt: null; // 文章简介
post_link: string; //
post_date: string; // 发布日期
is_favorite: integer; // 是否收藏
type: string; //
}>;
total: integer; // 附件数
total: integer; // 总数
};
* };
* }>}
......