接口文档更新

api_doc.md

@@ -5,6 +5,37 @@
 |current|int|是|当前页|
 |size|int|是|每页的数量|
 
+### 公共返回数据结构
+|参数名|参数类型|必填|参数说明|
+|-----|-----|-----|-----|
+|code|int|是|成功:200|
+|success|boolean|是|成功:true, 失败: false|
+|data|int|是|接口返回的业务数据|
+|msg|String|是|接口信息|
+
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```
+
+### h5接口列表
+|接口名称|路径|
+|-----|-----|
+|医院列表|blade-system/dept-hospital/list-hospital|
+|医院文章|blade-business/article/detail-publish|
+|用户黑名单验证|blade-business/blacklist/user-blacklist|
+|获取已放号天, 用于预约|blade-business/apm-config/already-config-day|
+|获取放号列表, 用于预约|blade-business/apm-config/detail-for-apm|
+|保存预约|blade-business/apm-record/save|
+|查看我的预约|blade-business/apm-record/page|
+|取消预约|blade-business/apm-record/cancel|
+
+
+
 ## 1 公共接口
 ### 1.1 医院列表
 ##### URL
@@ -291,16 +322,73 @@
 ##### 请求参数
 |参数名|参数类型|参数说明|
 |-----|-----|-----|
-|apmRecordList|List|预约记录列表|
-|- createDept|Long|医院Id|
-|- project|String|体检项目|
-|- cuAddr|String|体检地址|
-|- period|String|时段|
-|- apmDay|String|体检天|
-|- timeFrame|String|时间范围|
-|- cupName|String|体检人名称|
-|- cupCardNo|String|体检人证件号|
-|- cupPhone|String|体检人手机号|
+|createDept|Long|医院Id|
+|project|String|体检项目|
+|cuAddr|String|体检地址|
+|period|String|时段|
+|apmDay|String|体检天|
+|timeFrame|String|时间范围|
+|cupName|String|体检人名称|
+|cupCardNo|String|体检人证件号|
+|cupPhone|String|体检人手机号|
+
+##### 请求示例
+```json
+[
+	{
+		"apmDay": "2023-02-13",
+		"createDept": "1",
+		"project": "单眼视力",
+		"cuAddr": "门诊楼3楼眼科门诊",
+		"period": "上午",
+		"timeFrame": "8:00-8:30",
+		"cupName": "张三",
+		"cupPhone": "17852327323",
+		"cupCardNo": "37092120000618034X"
+	},
+	{
+		"apmDay": "2023-02-13",
+		"createDept": "1",
+		"project": "听力",
+		"cuAddr": "门诊楼3楼听力门诊",
+		"period": "上午",
+		"timeFrame": "8:00-8:30",
+		"cupName": "张三",
+		"cupPhone": "17852327323",
+		"cupCardNo": "37092120000618034X"
+	}
+]
+```
+
+##### 返回参数
+###### 失败时msg参数说明
+|参数名|参数说明|
+|-----|-----|
+|"预约失败, 一次只能预约同一个人"|医院Id|
+|"预约失败, 一次只能预约同一天的体检项目"|体检项目|
+|"预约失败, 本日已有其他医院的预约"|体检项目|
+|"预约失败, 本日已有此项目的预约"|体检项目|
+
+##### 返回示例
+###### 失败示例
+```json
+{
+	"code": 400,
+	"success": false,
+	"data": {},
+	"msg": "预约失败, 一次只能预约同一个人"
+}
+```
+
+###### 成功示例
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```
 
 ### 3.5 取消预约记录
 ##### URL