# DocServer **Repository Path**: Loadstar_QYZ/doc-server ## Basic Information - **Project Name**: DocServer - **Description**: docserver-springboot - **Primary Language**: Java - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-03-12 - **Last Updated**: 2024-03-22 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 接口文档-V1.1 ``` 已知问题： postman可上传多张图片，只接受第一张 ``` ## 1. 用户相关接口 ### 1.1 注册 #### 1.1.1 基本信息 > 请求路径：/user/register > > 请求方式：POST > > 接口描述：该接口用于注册新用户 #### 1.1.2 请求参数 请求参数格式：x-www-form-urlencoded 请求参数说明： | 参数名称 | 说明 | 类型 | 是否必须 | 备注 | | -------- | ------ | ------ | -------- | -------------- | | username | 用户名 | string | 是 | 5~16位非空字符 | | password | 密码 | string | 是 | 5~16位非空字符 | 请求数据样例： ``` username=zhangsan&password=123456 ``` #### 1.1.3 响应数据 响应数据类型：application/json 响应参数说明： | 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | | ------- | ------ | -------- | ------ | --------------------- | -------- | | code | number | 必须 | | 响应码, 0-成功,1-失败 | | | message | string | 非必须 | | 提示信息 | | | data | object | 非必须 | | 返回的数据 | | 响应数据样例： ```json { "code": 0, "message": "操作成功", "data": null } ``` ### 1.2 登录 #### 1.2.1 基本信息 > 请求路径：/user/login > > 请求方式：POST > > 接口描述：该接口用于登录 #### 1.2.2 请求参数 请求参数格式：x-www-form-urlencoded 请求参数说明： | 参数名称 | 说明 | 类型 | 是否必须 | 备注 | | -------- | ------ | ------ | -------- | -------------- | | username | 用户名 | string | 是 | 5~16位非空字符 | | password | 密码 | string | 是 | 5~16位非空字符 | 请求数据样例： ``` username=zhangsan&password=123456 ``` #### 1.2.3 响应数据 响应数据类型：application/json 响应参数说明： | 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | | ------- | ------ | -------- | ------ | --------------------- | -------- | | code | number | 必须 | | 响应码, 0-成功,1-失败 | | | message | string | 非必须 | | 提示信息 | | | data | string | 必须 | | 返回的数据,jwt令牌 | | 响应数据样例： ```json { "code": 0, "message": "操作成功", "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGFpbXMiOnsiaWQiOjUsInVzZXJuYW1lIjoid2FuZ2JhIn0sImV4cCI6MTY5MzcxNTk3OH0.pE_RATcoF7Nm9KEp9eC3CzcBbKWAFOL0IsuMNjnZ95M" } ``` #### 1.2.4 备注说明 > 用户登录成功后，系统会自动下发JWT令牌，然后在后续的每次请求中，浏览器都需要在请求头header中携带到服务端，请求头的名称为 Authorization，值为 登录时下发的JWT令牌。 > > 如果检测到用户未登录，则http响应状态码为401 ## 2. 诊断接口 ### 2.1 添加诊断 ok #### 2.1.1 基本信息 > 请求路径：/diag/add > > 请求方式：POST > > 接口描述：接受用户上传的病例图片，并新建诊断 #### 2.1.2 请求参数 请求参数格式：multipart/form-data 请求参数说明： | 参数名称 | 说明 | 类型 | 是否必须 | 备注 | | | -------- | ------------------------ | ---- | -------- | ---- | ---- | | file | 表单中文件请求参数的名字 | file | 是 | | | 请求数据样例： 无 #### 2.1.3 响应数据 响应数据类型：application/json 响应参数说明： | 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | | ------- | ------ | -------- | ------ | ------------------------ | -------- | | code | number | 必须 | | 响应码, 0-成功,1-失败 | | | message | string | 非必须 | | 提示信息 | | | data | Object | 非必须 | | | | 响应数据样例： ```json { "code": 0, "message": "操作成功", "data": "null" } ``` #### 2.1.4 其他 被图像识别监听，一有新增就把图片给去处理，或者直接给过去。怎么实现呢？ ### 2.2 获取诊断列表 #### 2.2.1 基本信息 > 请求路径：/diag/list > > 请求方式：GET > > 接口描述：该接口用于获取当前已登录用户创建的所有诊断 #### 2.2.2 请求参数 无 #### 2.2.3 响应数据 响应数据类型：application/json 响应参数说明： | 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | | ---------------- | ------ | -------- | ------ | --------------------- | -------- | | code | number | 必须 | | 响应码, 0-成功,1-失败 | | | message | string | 非必须 | | 提示信息 | | | data | array | 必须 | | 返回的数据 | | | \|-id | number | 非必须 | | 主键ID | | | \|-pic_location | string | 非必须 | | 图片url | | | \|-createTime | string | 非必须 | | 创建时间 | | | \|-updateTime | string | 非必须 | | 修改时间 | | 响应数据样例： ```json { "code": 0, "message": "success", "data": [ { "diag_id": 1, "uid": 1, "pic_location": "c54538fa-e8be-469c-8204-a90b24de9e8f.jpg", "diag_location": "", "create_time": "2024-03-14 14:40:24", "update_time": "2024-03-14 14:45:35", "deleted": true, "state": 0 }, // 省略…… { "diag_id": 4, "uid": 1, "pic_location": "4b876347-e3ee-4010-b554-c5d84e542491.txt", "diag_location": "", "create_time": "2024-03-15 09:14:27", "update_time": "2024-03-15 09:14:27", "deleted": false, "state": 0 } ] } ``` ### 2.3 获取诊断详情 #### 2.3.1 基本信息 > 请求路径：/diag/detail > > 请求方式：GET > > 接口描述：该接口用于根据ID获取诊断详情 #### 2.4.2 请求参数 请求参数格式：queryString 请求参数说明： | 参数名称 | 说明 | 类型 | 是否必须 | 备注 | | -------- | ------ | ------ | -------- | ---- | | id | 主键ID | number | 是 | | 请求数据样例： ``` id=6 ``` #### 2.3.3 响应数据 响应数据类型：application/json 响应参数说明： | 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | | ---------------- | ------ | -------- | ------ | --------------------- | -------- | | code | number | 必须 | | 响应码, 0-成功,1-失败 | | | message | string | 非必须 | | 提示信息 | | | data | object | 必须 | | 返回的数据 | | | \|-id | number | 非必须 | | 主键ID | | | \|-pic_location | string | 非必须 | | 图片路径 | | | \|-diag_location | string | 非必须 | | 诊断路径 | | | \|-createTime | string | 非必须 | | 创建时间 | | | \|-updateTime | string | 非必须 | | 修改时间 | | 响应数据样例： ```json { "code": 0, "message": "success", "data": { "diag_id": 4, "uid": 1, "pic_location": "4b876347-e3ee-4010-b554-c5d84e542491.txt", "diag_location": "", "create_time": "2024-03-15 09:14:27", "update_time": "2024-03-15 09:14:27", "deleted": false, "state": 0 } } ``` ### 2.5 删除诊断 ok #### 2.5.1 基本信息 > 请求路径：/diag > > 请求方式：DELETE > > 接口描述：该接口用于根据ID删除诊断 #### 2.5.2 请求参数 请求参数格式：queryString 请求参数说明： | 参数名称 | 说明 | 类型 | 是否必须 | 备注 | | -------- | ------ | ------ | -------- | ---- | | id | 主键ID | number | 是 | | 请求数据样例： ``` id=6 ``` #### 2.5.3 响应数据 响应数据类型：application/json 响应参数说明： | 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | | ------- | ------ | -------- | ------ | --------------------- | -------- | | code | number | 必须 | | 响应码, 0-成功,1-失败 | | | message | string | 非必须 | | 提示信息 | | | data | object | 非必须 | | 返回的数据 | | 响应数据样例： ```json { "code": 0, "message": "success", "data": null } ``` ### 2.6 修改诊断图片（要不要？还是直接只留删除）