docs: 新增API变更检测工具使用指南并更新接口文档
新增API变更检测工具的详细使用指南文档,说明工具的工作原理、使用方式、变更类型分类及CI/CD集成方法。 同时更新用户接口文档:为editUserInfo接口添加可选参数sms_code,并从getUserInfo接口文档中移除已不存在的include_profile参数。
Showing
2 changed files
with
1 additions
and
1 deletions
| ... | @@ -11,6 +11,7 @@ const Api = { | ... | @@ -11,6 +11,7 @@ const Api = { |
| 11 | * @param {string} params.name (可选) 姓名 | 11 | * @param {string} params.name (可选) 姓名 |
| 12 | * @param {string} params.avatar (可选) 头像 | 12 | * @param {string} params.avatar (可选) 头像 |
| 13 | * @param {string} params.mobile (可选) 手机号 | 13 | * @param {string} params.mobile (可选) 手机号 |
| 14 | + * @param {string} params.sms_code (可选) 短信验证码 | ||
| 14 | * @param {string} params.idcard (可选) 身份证 | 15 | * @param {string} params.idcard (可选) 身份证 |
| 15 | * @returns {Promise<{ | 16 | * @returns {Promise<{ |
| 16 | * code: number; // 状态码 | 17 | * code: number; // 状态码 |
| ... | @@ -23,7 +24,6 @@ export const editUserInfoAPI = (params) => fn(fetch.post(Api.EditUserInfo, param | ... | @@ -23,7 +24,6 @@ export const editUserInfoAPI = (params) => fn(fetch.post(Api.EditUserInfo, param |
| 23 | /** | 24 | /** |
| 24 | * @description: 查询我的信息 | 25 | * @description: 查询我的信息 |
| 25 | * @param {Object} params 请求参数 | 26 | * @param {Object} params 请求参数 |
| 26 | - * @param {boolean} params.include_profile (可选) 是否包含完整资料信息 | ||
| 27 | * @returns {Promise<{ | 27 | * @returns {Promise<{ |
| 28 | * code: number; // 状态码 | 28 | * code: number; // 状态码 |
| 29 | * msg: string; // 消息 | 29 | * msg: string; // 消息 | ... | ... |
-
Please register or login to post a comment