Hooke / manulife-weapp

Go to a project
Toggle navigation Toggle navigation pinning
You need to sign in or sign up before continuing.
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: ...@@ -44,7 +44,7 @@ paths:
44 type: string 44 type: string
45 - name: type 45 - name: type
46 in: query 46 in: query
47 - description: product=产品，file=文档 47 + description: product=产品，article=文章
48 required: false 48 required: false
49 schema: 49 schema:
50 type: string 50 type: string
...@@ -155,7 +155,7 @@ paths: ...@@ -155,7 +155,7 @@ paths:
155 - list 155 - list
156 - total 156 - total
157 title: 产品列表 157 title: 产品列表
158 - files: 158 + article:
159 type: object 159 type: object
160 properties: 160 properties:
161 list: 161 list:
...@@ -165,61 +165,50 @@ paths: ...@@ -165,61 +165,50 @@ paths:
165 properties: 165 properties:
166 id: 166 id:
167 type: integer 167 type: integer
168 - title: 附件id 168 + post_title:
169 - name:
170 type: string 169 type: string
171 - title: 附件名 170 + title: 文章标题
172 - value: 171 + post_excerpt:
172 + type: 'null'
173 + title: 文章简介
174 + post_link:
173 type: string 175 type: string
174 - title: 附件地址
175 - extension:
176 - type: string
177 - title: 附件类型
178 post_date: 176 post_date:
179 type: string 177 type: string
180 - title: 发布时间 178 + title: 发布日期
181 - size:
182 - type: string
183 - title: 附件大小
184 is_favorite: 179 is_favorite:
185 type: integer 180 type: integer
186 title: 是否收藏 181 title: 是否收藏
187 - type:
188 - type: string
189 required: 182 required:
190 - id 183 - id
191 - - name 184 + - post_title
192 - - value 185 + - post_excerpt
193 - - extension 186 + - post_link
194 - post_date 187 - post_date
195 - - size
196 - is_favorite 188 - is_favorite
197 - - type
198 x-apifox-orders: 189 x-apifox-orders:
199 - id 190 - id
200 - - name 191 + - post_title
201 - - value 192 + - post_excerpt
202 - - extension 193 + - post_link
203 - post_date 194 - post_date
204 - - size
205 - is_favorite 195 - is_favorite
206 - - type
207 total: 196 total:
208 type: integer 197 type: integer
209 - title: 附件数 198 + title: 总数
210 required: 199 required:
211 - list 200 - list
212 - total 201 - total
213 x-apifox-orders: 202 x-apifox-orders:
214 - list 203 - list
215 - total 204 - total
216 - title: 文件列表 205 + title: 文章列表
217 required: 206 required:
218 - products 207 - products
219 - - files 208 + - article
220 x-apifox-orders: 209 x-apifox-orders:
221 - products 210 - products
222 - - files 211 + - article
223 required: 212 required:
224 - code 213 - code
225 - msg 214 - msg
...@@ -228,96 +217,7 @@ paths: ...@@ -228,96 +217,7 @@ paths:
228 - code 217 - code
229 - msg 218 - msg
230 - data 219 - data
231 - example: |- 220 + 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"
232 - {
233 - "code": 1,
234 - "msg": 0,
235 - "data": {
236 - "products": {
237 - "list": [
238 - {
239 - "id": 2769848,
240 - "product_name": "1111",
241 - "product_description": "<p>5564</p>\r\n<p>hdye</p>",
242 - "recommend": "normal",
243 - "created_time": "2026-02-02 16:33:01",
244 - "cover_image": "https://cdn.ipadbiz.cn/space_30901/申请提交-生成计划书_FvdRVOS0K-Wmp05ZKHpx64sEXcKQ.png",
245 - "tags": [
246 - {
247 - "id": "2769846",
248 - "name": "测试1",
249 - "bg_color": "#1e9fff",
250 - "text_color": "#ffffff"
251 - },
252 - {
253 - "id": "2769847",
254 - "name": "111",
255 - "bg_color": "#3e5160",
256 - "text_color": "#ffffff"
257 - }
258 - ],
259 - "type": "product"
260 - },
261 - {
262 - "id": 2769845,
263 - "product_name": "1",
264 - "product_description": null,
265 - "recommend": "normal",
266 - "created_time": "2026-02-02 16:22:26",
267 - "cover_image": null,
268 - "tags": [],
269 - "type": "product"
270 - }
271 - ],
272 - "total": 2,
273 - },
274 - "files": {
275 - "list": [
276 - {
277 - "id": 2769815,
278 - "name": "9751dd823b7542d78fa7bde615a43ba1",
279 - "value": "https://cdn.ipadbiz.cn/space_30901/9751dd823b7542d78fa7bde615a43ba1_Fsm43FPaZOwKc5pwbxhk-h2zUUsu.png",
280 - "extension": "png",
281 - "post_date": "2026-01-13 11:26:07",
282 - "size": "0 B",
283 - "is_favorite": 0,
284 - "type": "file"
285 - },
286 - {
287 - "id": 2769814,
288 - "name": "微信图片_2026-01-12_173653_750",
289 - "value": "https://cdn.ipadbiz.cn/space_30901/微信图片_2026-01-12_173653_750_Fuu11vu9Zp5B626kEbWE62vQLeA7.png",
290 - "extension": "png",
291 - "post_date": "2026-01-13 11:26:07",
292 - "size": "0 B",
293 - "is_favorite": 0,
294 - "type": "file"
295 - },
296 - {
297 - "id": 2769811,
298 - "name": "微信图片_2026-01-12_173913_253",
299 - "value": "https://cdn.ipadbiz.cn/space_30901/微信图片_2026-01-12_173913_253_FoQoABNxtf4dB2vKLD-Eke8Tsgu5.png",
300 - "extension": "png",
301 - "post_date": "2026-01-13 11:25:47",
302 - "size": "0 B",
303 - "is_favorite": 0,
304 - "type": "file"
305 - },
306 - {
307 - "id": 2768696,
308 - "name": "123222",
309 - "value": "https://cdn.ipadbiz.cn/space/30901/4c2ab735c6996a89d7c423bf428a1748.png",
310 - "extension": "png",
311 - "post_date": "2025-10-30 18:30:28",
312 - "size": "0 B",
313 - "is_favorite": 0,
314 - "type": "file"
315 - }
316 - ],
317 - "total": 4,
318 - }
319 - }
320 - }
321 headers: {} 221 headers: {}
322 x-apifox-name: 成功 222 x-apifox-name: 成功
323 x-apifox-ordering: 0 223 x-apifox-ordering: 0
......
...@@ -24,9 +24,28 @@ const Api = { ...@@ -24,9 +24,28 @@ const Api = {
24 post_date: string; // 发布日期 24 post_date: string; // 发布日期
25 post_author: integer; // 发布人id 25 post_author: integer; // 发布人id
26 author_name: string; // 发布人 26 author_name: string; // 发布人
27 + file_list: {
28 + icon: {
29 + meta_type: string; //
30 + id: integer; //
31 + object_id: null; //
32 + name: string; //
33 + value: string; //
34 + description: null; //
35 + extension: string; //
36 + post_date: string; //
37 + icon: null; //
38 + master_client_id: null; //
39 + hash: string; //
40 + height: string; //
41 + width: string; //
42 + author: integer; //
43 + size: null; //
44 + };
45 + };
27 is_favorite: integer; // 46 is_favorite: integer; //
28 * }; 47 * };
29 - * } >} 48 + * }>}
30 */ 49 */
31 export const articleDetailAPI = (params) => fn(fetch.get(Api.ArticleDetail, params)); 50 export const articleDetailAPI = (params) => fn(fetch.get(Api.ArticleDetail, params));
32 51
......
...@@ -13,8 +13,8 @@ const Api = { ...@@ -13,8 +13,8 @@ const Api = {
13 * @param {Object} params 请求参数 13 * @param {Object} params 请求参数
14 * @param {string} params.customer_name 申请人 14 * @param {string} params.customer_name 申请人
15 * @param {string} params.customer_gender 性别 15 * @param {string} params.customer_gender 性别
16 - * @param {integer} params.customer_age 年龄 16 + * @param {integer} params.customer_age (可选) 与 customer_birthday 二选一，至少提供一个
17 - * @param {string} params.customer_birthday 出生年月日 17 + * @param {string} params.customer_birthday (可选) 与 customer_age 二选一，至少提供一个。格式：YYYY-MM-DD
18 * @param {integer} params.annual_premium 保额 18 * @param {integer} params.annual_premium 保额
19 * @param {string} params.payment_years 繳費年期 19 * @param {string} params.payment_years 繳費年期
20 * @param {string} params.currency_type 币种 20 * @param {string} params.currency_type 币种
......
...@@ -9,7 +9,7 @@ const Api = { ...@@ -9,7 +9,7 @@ const Api = {
9 * @remark 9 * @remark
10 * @param {Object} params 请求参数 10 * @param {Object} params 请求参数
11 * @param {string} params.keyword (可选) 11 * @param {string} params.keyword (可选)
12 - * @param {string} params.type (可选) product=产品，file=文档 12 + * @param {string} params.type (可选) product=产品，article=文章
13 * @returns {Promise<{ 13 * @returns {Promise<{
14 * code: number; // 状态码 14 * code: number; // 状态码
15 * msg: string; // 消息 15 * msg: string; // 消息
...@@ -33,18 +33,16 @@ const Api = { ...@@ -33,18 +33,16 @@ const Api = {
33 }>; 33 }>;
34 total: integer; // 产品总数 34 total: integer; // 产品总数
35 }; 35 };
36 - files: { 36 + article: {
37 list: Array<{ 37 list: Array<{
38 - id: integer; // 附件id 38 + id: integer; //
39 - name: string; // 附件名 39 + post_title: string; // 文章标题
40 - value: string; // 附件地址 40 + post_excerpt: null; // 文章简介
41 - extension: string; // 附件类型 41 + post_link: string; //
42 - post_date: string; // 发布时间 42 + post_date: string; // 发布日期
43 - size: string; // 附件大小
44 is_favorite: integer; // 是否收藏 43 is_favorite: integer; // 是否收藏
45 - type: string; //
46 }>; 44 }>;
47 - total: integer; // 附件数 45 + total: integer; // 总数
48 }; 46 };
49 * }; 47 * };
50 * }>} 48 * }>}
......