das接口文档修改
This commit is contained in:
chenhaojie
parent
aa23795886
commit
dfd8b0416c
@ -43,6 +43,7 @@
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "操作成功",
|
||||
"success": true,
|
||||
"data": {
|
||||
"img": "",
|
||||
"key": "9007a0158f7c4635b4e6e577de7406e0"
|
||||
@ -163,9 +164,9 @@
|
||||
|
||||
## API接口一览表
|
||||
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
| :------: | :------------ | :---------------- | ---- |
|
||||
| 菜单管理 | 2.1、新增菜单 | /api/menus | |
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
| :------: | :------------ |:------------------| ---- |
|
||||
| 菜单管理 | 2.1、新增菜单 | /api/menus/add | |
|
||||
| 菜单管理 | 2.2、查询菜单 | /api/menus/query | |
|
||||
| 菜单管理 | 2.3、更新菜单 | /api/menus/update | |
|
||||
| 菜单管理 | 2.4、删除菜单 | /api/menus/delete | |
|
||||
@ -173,7 +174,7 @@
|
||||
## 2.1、新增菜单
|
||||
|
||||
```java
|
||||
@PostMapping("/api/menus")
|
||||
@PostMapping("/api/menus/add")
|
||||
public ResponseEntity<?> createMenu(@RequestBody MenuDto menuDto) {
|
||||
// 处理菜单的创建逻辑
|
||||
// ...
|
||||
@ -223,6 +224,7 @@ public class MenuDto implements Serializable {
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "操作成功",
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": "123",
|
||||
"menuName": "菜单1",
|
||||
@ -273,6 +275,7 @@ public class MenuQueryDto implements Serializable {
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "操作成功",
|
||||
"success": true,
|
||||
"data": [
|
||||
{
|
||||
"id": "123",
|
||||
@ -365,31 +368,28 @@ public class MenuDeleteDto {
|
||||
|
||||
## API接口一览表
|
||||
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
| :------: | :----------- | :----------------- | --------------- |
|
||||
| 公司机构 | 公司机构查询 | /api/org/getOrgs | /XXXX/XXX/XXX/X |
|
||||
| 公司机构 | 添加机构信息 | /api/org/addOrg | |
|
||||
| 公司机构 | 修改机构信息 | /api/org/updateOrg | |
|
||||
| 公司机构 | 删除指定机构 | /api/org/deleteOrg | |
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
| :------: | :----------- |:----------------|----|
|
||||
| 公司机构 | 公司机构查询 | /api/org/query | |
|
||||
| 公司机构 | 添加机构信息 | /api/org/add | |
|
||||
| 公司机构 | 修改机构信息 | /api/org/update | |
|
||||
| 公司机构 | 删除指定机构 | /api/org/delete | |
|
||||
|
||||
## 公司机构查询
|
||||
|
||||
提供获取所有机构信息的功能，POST方式
|
||||
|
||||
> /api/org/getOrgs
|
||||
> /api/org/query
|
||||
|
||||
入参示例
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "12351346324324",
|
||||
"name":"12",
|
||||
"parentOrgId":"xx",
|
||||
"mrid":"xxx",
|
||||
"province":"xx",
|
||||
"city":"xxx",
|
||||
"county":"xxx",
|
||||
"token":"xxx"
|
||||
"county":"xxx"
|
||||
}
|
||||
```
|
||||
|
||||
@ -399,11 +399,9 @@ public class MenuDeleteDto {
|
||||
| ----------- | -------- | ---- | -------------------------------------- |
|
||||
| name | String | YES | 机构名称，当名称为空时查询所有机构数据 |
|
||||
| parentOrgId | String | YES | 上级机构ID |
|
||||
| mrid | String | YES | 编码 |
|
||||
| province | String | YES | 省 |
|
||||
| city | String | YES | 城市 |
|
||||
| county | String | YES | 区县 |
|
||||
| token | String | NO | token |
|
||||
|
||||
调用成功返回示例
|
||||
|
||||
@ -428,7 +426,8 @@ public class MenuDeleteDto {
|
||||
...
|
||||
}
|
||||
],
|
||||
"msg":"调用成功"
|
||||
"msg":"调用成功",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -454,23 +453,40 @@ public class MenuDeleteDto {
|
||||
|
||||
根据添加的机构信息创建机构，POST方式
|
||||
|
||||
>/api/org/addOrg
|
||||
>/api/org/add
|
||||
|
||||
入参示例
|
||||
|
||||
```
|
||||
{
|
||||
"mrid": "xxx",
|
||||
"name": "xxx",
|
||||
"aliasName":"xxx",
|
||||
"province": "xxx",
|
||||
"city": "xxx",
|
||||
"county": "xxx",
|
||||
"address": "xxx",
|
||||
"contactPhone":"xxx",
|
||||
"remarks":"xxx",
|
||||
"parentOrgId":"xxxx",
|
||||
"token":"xxx"
|
||||
/** 机构名称 */
|
||||
private String name ;
|
||||
/** 机构编码 */
|
||||
private String mrid ;
|
||||
/** 省份 */
|
||||
private String province ;
|
||||
/** 城市 */
|
||||
private String city ;
|
||||
/** 区县 */
|
||||
private String county ;
|
||||
/** 详细地址 */
|
||||
private String address ;
|
||||
/** 联系电话 */
|
||||
private String contactPhone ;
|
||||
/** 备注 */
|
||||
private String remarks ;
|
||||
/** 上级机构id */
|
||||
private Long parentOrgId ;
|
||||
/** 乐观锁 */
|
||||
private Integer revision ;
|
||||
/** 创建人 */
|
||||
private String createdBy ;
|
||||
/** 创建时间 */
|
||||
private Date createdTime ;
|
||||
/** 更新人 */
|
||||
private String updatedBy ;
|
||||
/** 更新时间 */
|
||||
private Date updatedTime ;
|
||||
}
|
||||
```
|
||||
|
||||
@ -496,7 +512,8 @@ public class MenuDeleteDto {
|
||||
{
|
||||
"code":"200",
|
||||
"msg":"添加成功",
|
||||
"data":"null"
|
||||
"data":"null",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -506,7 +523,7 @@ public class MenuDeleteDto {
|
||||
|
||||
根据提供的机构ID,修改机构信息，POST方式
|
||||
|
||||
> /api/org/updateOrg
|
||||
> /api/org/update
|
||||
|
||||
入参示例
|
||||
|
||||
@ -522,8 +539,7 @@ public class MenuDeleteDto {
|
||||
"address": "xxx",
|
||||
"contactPhone":"xxx",
|
||||
"remarks":"xxx",
|
||||
"parentOrgId":"xxxx",
|
||||
"token":"xxx"
|
||||
"parentOrgId":"xxxx"
|
||||
}
|
||||
```
|
||||
|
||||
@ -542,7 +558,6 @@ public class MenuDeleteDto {
|
||||
| contactPhone | String | No | 联系电话 |
|
||||
| remarks | String | No | 备注 |
|
||||
| parentOrgId | Long | No | 上级机构ID |
|
||||
| token | String | NO | token |
|
||||
|
||||
|
||||
|
||||
@ -554,7 +569,8 @@ public class MenuDeleteDto {
|
||||
{
|
||||
"code":"200",
|
||||
"msg":"修改成功",
|
||||
"data":"null"
|
||||
"data":"null",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -564,14 +580,13 @@ public class MenuDeleteDto {
|
||||
|
||||
根据提供的机构ID,删除机构信息，POST方式
|
||||
|
||||
>/api/org/deleteOrg
|
||||
>/api/org/delete
|
||||
|
||||
入参示例
|
||||
|
||||
```
|
||||
{
|
||||
"id":"111",
|
||||
"token":"xxx"
|
||||
"id":"111"
|
||||
}
|
||||
```
|
||||
|
||||
@ -580,7 +595,6 @@ public class MenuDeleteDto {
|
||||
| 参数名 | 参数类型 | 可选 | 描述 |
|
||||
| ------ | -------- | ---- | ---------------- |
|
||||
| id | Long | No | 要删除的机构主键 |
|
||||
| token | String | YES | token |
|
||||
|
||||
调用成功返回示例
|
||||
|
||||
@ -588,7 +602,8 @@ public class MenuDeleteDto {
|
||||
{
|
||||
"code":"200",
|
||||
"msg":"修改成功",
|
||||
"data":"null"
|
||||
"data":"null",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -600,18 +615,18 @@ public class MenuDeleteDto {
|
||||
|
||||
## API接口一览表
|
||||
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
| :------: | :------- | :------------------- | --------------- |
|
||||
| 职员操作 | 职员查询 | /api/user/getUser | /XXXX/XXX/XXX/X |
|
||||
| 职员操作 | 职员创建 | /api/user/addUser | |
|
||||
| 职员操作 | 职员修改 | /api/user/updateUser | |
|
||||
| 职员操作 | 职员删除 | /api/user/deleteUser | |
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
| :------: | :------- |:-----------------|----|
|
||||
| 职员操作 | 职员查询 | /api/user/query | |
|
||||
| 职员操作 | 职员创建 | /api/user/add | |
|
||||
| 职员操作 | 职员修改 | /api/user/update | |
|
||||
| 职员操作 | 职员删除 | /api/user/delete | |
|
||||
|
||||
## 职员查询
|
||||
|
||||
提供对职员信息的基本查询功能,POST方式。
|
||||
|
||||
>/api/user/getUser
|
||||
>/api/user/query
|
||||
|
||||
入参示例
|
||||
|
||||
@ -619,17 +634,17 @@ public class MenuDeleteDto {
|
||||
{
|
||||
"userName":"xx",
|
||||
"orgId":"xxx",
|
||||
"token":"xxx"
|
||||
"phone":"xxx"
|
||||
}
|
||||
```
|
||||
|
||||
入参描述
|
||||
|
||||
| 参数名 | 参数类型 | 可选 | 描述 |
|
||||
| :------- | :------: | :---: | :------------------------------------------------- |
|
||||
| 参数名 | 参数类型 | 可选 | 描述 |
|
||||
|:---------| :------: | :---: |:--------------------------|
|
||||
| userName | String | Yes | 模糊查询职员名称，当职员名称为空时查询所有职员信息 |
|
||||
| orgId | BIGINT | Yes | 所属机构ID |
|
||||
| token | String | NO | token |
|
||||
| orgId | BIGINT | Yes | 所属机构ID |
|
||||
| phone | String | Yes | 手机号，模糊查询 |
|
||||
|
||||
调用成功返回示例
|
||||
|
||||
@ -650,7 +665,8 @@ public class MenuDeleteDto {
|
||||
{
|
||||
...
|
||||
}
|
||||
]
|
||||
],
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -668,7 +684,7 @@ public class MenuDeleteDto {
|
||||
|
||||
根据提供的职员信息创建职员，POST方式。
|
||||
|
||||
>/api/user/addUser
|
||||
>/api/user/add
|
||||
|
||||
入参示例
|
||||
|
||||
@ -679,8 +695,7 @@ public class MenuDeleteDto {
|
||||
"userName": "xxx",
|
||||
"email":"xxx",
|
||||
"phone":"xxx",
|
||||
"orgId":"xxx",
|
||||
"token":"xxx"
|
||||
"orgId":"xxx"
|
||||
}
|
||||
```
|
||||
|
||||
@ -694,7 +709,6 @@ public class MenuDeleteDto {
|
||||
| email | String | No | 职员邮箱 |
|
||||
| phone | String | No | 职员联系电话 |
|
||||
| orgId | BIGINT | No | 所属机构ID |
|
||||
| token | String | NO | token |
|
||||
|
||||
调用成功返回示例
|
||||
|
||||
@ -702,7 +716,8 @@ public class MenuDeleteDto {
|
||||
{
|
||||
"code":"200",
|
||||
"msg":"创建成功",
|
||||
"data":"null"
|
||||
"data":"null",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -712,7 +727,7 @@ public class MenuDeleteDto {
|
||||
|
||||
根据提供的职员id,修改职员信息，POST方式。
|
||||
|
||||
>/api/user/updateUser
|
||||
>/api/user/update
|
||||
|
||||
|
||||
|
||||
@ -724,8 +739,7 @@ public class MenuDeleteDto {
|
||||
"userName": "xxx",
|
||||
"email":"xxx",
|
||||
"phone":"xxx",
|
||||
"orgId":"xxx",
|
||||
"token":"xxx"
|
||||
"orgId":"xxx"
|
||||
}
|
||||
```
|
||||
|
||||
@ -740,7 +754,6 @@ public class MenuDeleteDto {
|
||||
| email | String | No | 职员邮箱 |
|
||||
| phone | String | No | 职员联系电话 |
|
||||
| orgId | BIGINT | No | 所属机构ID |
|
||||
| token | String | NO | token |
|
||||
|
||||
调用成功返回示例
|
||||
|
||||
@ -748,7 +761,8 @@ public class MenuDeleteDto {
|
||||
{
|
||||
"code":"200",
|
||||
"msg":"修改成功",
|
||||
"data":"null"
|
||||
"data":"null",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -756,14 +770,13 @@ public class MenuDeleteDto {
|
||||
|
||||
根据提供的职员id,删除职员信息，POST方式。
|
||||
|
||||
> /api/user/deleteUser
|
||||
> /api/user/delete
|
||||
|
||||
入参示例
|
||||
|
||||
```
|
||||
{
|
||||
"id":"123",
|
||||
"token":"xxx"
|
||||
"id":"123"
|
||||
}
|
||||
```
|
||||
|
||||
@ -772,7 +785,6 @@ public class MenuDeleteDto {
|
||||
| 参数名 | 参数类型 | 可选 | 描述 |
|
||||
| ------ | -------- | ---- | -------------- |
|
||||
| id | BIGINT | No | 要删除的职员Id |
|
||||
| token | String | NO | token |
|
||||
|
||||
调用成功返回示例
|
||||
|
||||
@ -780,7 +792,8 @@ public class MenuDeleteDto {
|
||||
{
|
||||
"code":"200",
|
||||
"msg":"修改成功",
|
||||
"data":"null"
|
||||
"data":"null",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user