sx/map
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

das接口文档修改

Browse Source
This commit is contained in:
chenhaojie 2024-06-24 09:44:05 +08:00
parent 4544b27298
commit 730464ef4c
1 changed files with 73 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

181
docs/api/api_list.md
View File

@ -174,47 +174,27 @@
## 2.1、新增菜单
```java
@PostMapping("/api/menus/add")
public ResponseEntity<?> createMenu(@RequestBody MenuDto menuDto) {
// 处理菜单的创建逻辑
// ...
}
请求接口 /api/menus/add
```
入参定义
```java
import lombok.Data;
import java.io.Serializable;
```json
@Data
public class MenuDto implements Serializable {
/** 菜单ID */
private Long id ;
/** 菜单名称 */
private String menuName ;
/** 菜单排列顺序 */
private Integer menuOrder ;
/** 菜单图标名称 */
private String menuIcon ;
/** 菜单操作类型 */
private Integer funType ;
/** 菜单操作参数 */
private String funParam ;
/** 权限ID */
private Long authorityId ;
/** 上级菜单ID */
private Long parentMenuId ;
/** 乐观锁 */
private Integer revision ;
/** 创建人 */
private String createdBy ;
/** 创建时间 */
private Date createdTime ;
/** 更新人 */
private String updatedBy ;
/** 更新时间 */
private Date updatedTime ;
{
"id": "123",
"menuName": "菜单1",
"menuOrder": 1,
"menuIcon": "icon1",
"funType": 1,
"funParam": "param",
"authorityId": "123",
"parentMenuId": "0",
"revision": 1,
"createdBy": "aaa",
"createdTime": 123456,
"updatedBy": "aaa",
"updatedTime": 12345
}
```
@ -246,26 +226,15 @@ public class MenuDto implements Serializable {
## 2.2、查询菜单
```java
@PostMapping("/api/menus/query")
public ResponseEntity<?> queryMenus(@RequestBody MenuQueryDto menuQueryDto) {
// 处理查询逻辑并返回菜单列表
// ...
return ResponseEntity.ok(menus); // 假设menus是查询结果列表
}
请求接口 /api/menus/query
```
入参定义
```java
import lombok.Data;
import java.io.Serializable;
@Data
public class MenuQueryDto implements Serializable {
/** 菜单ID */
private Long id ;
/** 上级菜单ID */
private Long parentMenuId ;
```json
{
"id": "123",
"parentMenuId": "0"
}
```
@ -299,63 +268,59 @@ public class MenuQueryDto implements Serializable {
## 2.3、更新菜单
```java
@PostMapping("/api/menus/update")
public ResponseEntity<?> updateMenu(@RequestBody MenuUpdateDto menuUpdateDto) {
// 验证ID并处理菜单的更新逻辑
// ...
return ResponseEntity.ok().build();
}
请求接口
/api/menus/update
// MenuUpdateDto 示例
public class MenuUpdateDto {
/** 菜单ID */
private Long id ;
/** 菜单名称 */
private String menuName ;
/** 菜单排列顺序 */
private Integer menuOrder ;
/** 菜单图标名称 */
private String menuIcon ;
/** 菜单操作类型 */
private Integer funType ;
/** 菜单操作参数 */
private String funParam ;
/** 权限ID */
private Long authorityId ;
/** 上级菜单ID */
private Long parentMenuId ;
/** 乐观锁 */
private Integer revision ;
/** 创建人 */
private String createdBy ;
/** 创建时间 */
private Date createdTime ;
/** 更新人 */
private String updatedBy ;
/** 更新时间 */
private Date updatedTime ;
```
入参定义
```json
{
"id": "123",
"menuName": "菜单1",
"menuOrder": 1,
"menuIcon": "icon1",
"funType": 1,
"funParam": "param",
"authorityId": "123",
"parentMenuId": "0",
"revision": 1
}
```
调用成功返回示例
```json
{
"code":"200",
"msg":"更新成功",
"data":"null",
"success": true
}
```
## 2.4、删除菜单
```java
@PostMapping("/api/menus/delete")
public ResponseEntity<?> deleteMenu(@RequestBody MenuDeleteDto menuDeleteDto) {
// 验证ID并处理菜单的删除逻辑
// ...
return ResponseEntity.noContent().build();
}
// MenuDeleteDto 示例
public class MenuDeleteDto {
/** 菜单ID */
private Long id;
请求接口 /api/menus/delete
```
入参定义
```json
{
"id": ""
}
```
调用成功返回示例
```json
{
"code":"200",
"msg":"成功",
"data":"null",
"success": true
}
```
@ -563,9 +528,7 @@ public class MenuDeleteDto {
调用成功返回示例
```
```json
{
"code":"200",
"msg":"修改成功",
@ -584,7 +547,7 @@ public class MenuDeleteDto {
入参示例
```
```json
{
"id":"111"
}
@ -598,7 +561,7 @@ public class MenuDeleteDto {
调用成功返回示例
```
```json
{
"code":"200",
"msg":"修改成功",
@ -630,7 +593,7 @@ public class MenuDeleteDto {
入参示例
```
```json
{
"userName":"xx",
"orgId":"xxx",
@ -688,7 +651,7 @@ public class MenuDeleteDto {
入参示例
```
```json
{
"account": "xxx",
"password": "xxx",
@ -712,7 +675,7 @@ public class MenuDeleteDto {
调用成功返回示例
```
```json
{
"code":"200",
"msg":"创建成功",
@ -731,7 +694,7 @@ public class MenuDeleteDto {
```
```json
{
"id":"xxx",
"account": "xxx",
@ -757,7 +720,7 @@ public class MenuDeleteDto {
调用成功返回示例
```
```json
{
"code":"200",
"msg":"修改成功",
@ -774,7 +737,7 @@ public class MenuDeleteDto {
入参示例
```
```json
{
"id":"123"
}
@ -788,7 +751,7 @@ public class MenuDeleteDto {
调用成功返回示例
```
```json
{
"code":"200",
"msg":"修改成功",