manager/zyplayer-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

增加自建API接口操作

Browse Source
This commit is contained in:
暮光：城中城
2021-12-22 23:00:10 +08:00
parent 956b3b7c19
commit 7110ce45cc
24 changed files with 1013 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/entity/ApiCustomFolder.java Normal file
View File

@@ -0,0 +1,146 @@
package com.zyplayer.doc.data.repository.manage.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
/**
* <p>
* 自建接口文档文件夹
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
@TableName("api_custom_folder")
public class ApiCustomFolder implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 主键自增ID
*/
@TableId(value = "id", type = IdType.AUTO)
private Long id;
/**
* api_doc主键ID
*/
private Long docId;
/**
* 父文件夹ID
*/
private Long parentFolderId;
/**
* 文件夹名称
*/
private String folderName;
/**
* 文件夹说明
*/
private String folderDesc;
/**
* 创建人ID
*/
private Long createUserId;
/**
* 创建人名字
*/
private String createUserName;
/**
* 创建时间
*/
private Date createTime;
/**
* 是否有效 0=无效 1=有效
*/
private Integer yn;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public Long getDocId() {
return docId;
}
public void setDocId(Long docId) {
this.docId = docId;
}
public Long getParentFolderId() {
return parentFolderId;
}
public void setParentFolderId(Long parentFolderId) {
this.parentFolderId = parentFolderId;
}
public String getFolderName() {
return folderName;
}
public void setFolderName(String folderName) {
this.folderName = folderName;
}
public String getFolderDesc() {
return folderDesc;
}
public void setFolderDesc(String folderDesc) {
this.folderDesc = folderDesc;
}
public Long getCreateUserId() {
return createUserId;
}
public void setCreateUserId(Long createUserId) {
this.createUserId = createUserId;
}
public String getCreateUserName() {
return createUserName;
}
public void setCreateUserName(String createUserName) {
this.createUserName = createUserName;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
public Integer getYn() {
return yn;
}
public void setYn(Integer yn) {
this.yn = yn;
}
@Override
public String toString() {
return "ApiCustomFolder{" +
"id=" + id +
", docId=" + docId +
", parentFolderId=" + parentFolderId +
", folderName=" + folderName +
", folderDesc=" + folderDesc +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
"}";
}
}

198
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/entity/ApiCustomRequest.java Normal file
View File

@@ -0,0 +1,198 @@
package com.zyplayer.doc.data.repository.manage.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
/**
* <p>
* 自建接口文档
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
@TableName("api_custom_request")
public class ApiCustomRequest implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 主键自增ID
*/
@TableId(value = "id", type = IdType.AUTO)
private Long id;
/**
* api_doc主键ID
*/
private Long docId;
/**
* 文件夹ID
*/
private Long folderId;
/**
* 接口名称
*/
private String apiName;
/**
* 接口url
*/
private String apiUrl;
/**
* form参数
*/
private String formData;
/**
* body参数
*/
private String bodyData;
/**
* header参数
*/
private String headerData;
/**
* cookie参数
*/
private String cookieData;
/**
* 创建人ID
*/
private Long createUserId;
/**
* 创建人名字
*/
private String createUserName;
/**
* 创建时间
*/
private Date createTime;
/**
* 是否有效 0=无效 1=有效
*/
private Integer yn;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public Long getDocId() {
return docId;
}
public void setDocId(Long docId) {
this.docId = docId;
}
public Long getFolderId() {
return folderId;
}
public void setFolderId(Long folderId) {
this.folderId = folderId;
}
public String getApiName() {
return apiName;
}
public void setApiName(String apiName) {
this.apiName = apiName;
}
public String getApiUrl() {
return apiUrl;
}
public void setApiUrl(String apiUrl) {
this.apiUrl = apiUrl;
}
public String getFormData() {
return formData;
}
public void setFormData(String formData) {
this.formData = formData;
}
public String getBodyData() {
return bodyData;
}
public void setBodyData(String bodyData) {
this.bodyData = bodyData;
}
public String getHeaderData() {
return headerData;
}
public void setHeaderData(String headerData) {
this.headerData = headerData;
}
public String getCookieData() {
return cookieData;
}
public void setCookieData(String cookieData) {
this.cookieData = cookieData;
}
public Long getCreateUserId() {
return createUserId;
}
public void setCreateUserId(Long createUserId) {
this.createUserId = createUserId;
}
public String getCreateUserName() {
return createUserName;
}
public void setCreateUserName(String createUserName) {
this.createUserName = createUserName;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
public Integer getYn() {
return yn;
}
public void setYn(Integer yn) {
this.yn = yn;
}
@Override
public String toString() {
return "ApiCustomRequest{" +
"id=" + id +
", docId=" + docId +
", folderId=" + folderId +
", apiName=" + apiName +
", apiUrl=" + apiUrl +
", formData=" + formData +
", bodyData=" + bodyData +
", headerData=" + headerData +
", cookieData=" + cookieData +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
"}";
}
}

16
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/mapper/ApiCustomFolderMapper.java Normal file
View File

@@ -0,0 +1,16 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.ApiCustomFolder;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* 自建接口文档文件夹 Mapper 接口
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
public interface ApiCustomFolderMapper extends BaseMapper<ApiCustomFolder> {
}

16
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/mapper/ApiCustomRequestMapper.java Normal file
View File

@@ -0,0 +1,16 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.ApiCustomRequest;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* 自建接口文档 Mapper 接口
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
public interface ApiCustomRequestMapper extends BaseMapper<ApiCustomRequest> {
}

92
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/vo/ApiCustomDocVo.java Normal file
View File

@@ -0,0 +1,92 @@
package com.zyplayer.doc.data.repository.manage.vo;
import java.io.Serializable;
/**
* api自建文档信息
*
* @author 暮光：城中城
* @since 2021-11-25
*/
public class ApiCustomDocVo implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 接口名称
*/
private String apiName;
/**
* 接口url
*/
private String apiUrl;
/**
* form参数
*/
private String formData;
/**
* body参数
*/
private String bodyData;
/**
* header参数
*/
private String headerData;
/**
* cookie参数
*/
private String cookieData;
public String getApiName() {
return apiName;
}
public void setApiName(String apiName) {
this.apiName = apiName;
}
public String getApiUrl() {
return apiUrl;
}
public void setApiUrl(String apiUrl) {
this.apiUrl = apiUrl;
}
public String getFormData() {
return formData;
}
public void setFormData(String formData) {
this.formData = formData;
}
public String getBodyData() {
return bodyData;
}
public void setBodyData(String bodyData) {
this.bodyData = bodyData;
}
public String getHeaderData() {
return headerData;
}
public void setHeaderData(String headerData) {
this.headerData = headerData;
}
public String getCookieData() {
return cookieData;
}
public void setCookieData(String cookieData) {
this.cookieData = cookieData;
}
}

67
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/vo/ApiCustomVo.java Normal file
View File

@@ -0,0 +1,67 @@
package com.zyplayer.doc.data.repository.manage.vo;
import java.io.Serializable;
import java.util.List;
/**
* api自建文档信息
*
* @author 暮光：城中城
* @since 2021-11-25
*/
public class ApiCustomVo implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 文件夹名称
*/
private String name;
/**
* 文件夹说明
*/
private String desc;
/**
* 子目录列表
*/
private List<ApiCustomVo> children;
/**
* 接口列表
*/
private List<ApiCustomDocVo> apis;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getDesc() {
return desc;
}
public void setDesc(String desc) {
this.desc = desc;
}
public List<ApiCustomVo> getChildren() {
return children;
}
public void setChildren(List<ApiCustomVo> children) {
this.children = children;
}
public List<ApiCustomDocVo> getApis() {
return apis;
}
public void setApis(List<ApiCustomDocVo> apis) {
this.apis = apis;
}
}

2
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/support/generator/CodeGenerator.java
View File

@@ -16,7 +16,7 @@ import java.util.Collections;
public class CodeGenerator {
public static void main(String[] args) {
final String[] tableName = {"api_doc", "api_request_param", "api_global_param"};
final String[] tableName = {"api_custom_request", "api_custom_folder"};
String url = "jdbc:mysql://127.0.0.1:3306/zyplayer_doc_manage?useUnicode=true&useSSL=false&characterEncoding=utf8";
String projectPath = System.getProperty("user.dir") + "/zyplayer-doc-data";
String outputDir = projectPath + "/src/main/java";

16
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/service/manage/ApiCustomFolderService.java Normal file
View File

@@ -0,0 +1,16 @@
package com.zyplayer.doc.data.service.manage;
import com.zyplayer.doc.data.repository.manage.entity.ApiCustomFolder;
import com.baomidou.mybatisplus.extension.service.IService;
/**
* <p>
* 自建接口文档文件夹 服务类
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
public interface ApiCustomFolderService extends IService<ApiCustomFolder> {
}

26
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/service/manage/ApiCustomRequestService.java Normal file
View File

@@ -0,0 +1,26 @@
package com.zyplayer.doc.data.service.manage;
import com.zyplayer.doc.data.repository.manage.entity.ApiCustomRequest;
import com.baomidou.mybatisplus.extension.service.IService;
import com.zyplayer.doc.data.repository.manage.vo.ApiCustomVo;
import java.util.List;
/**
* <p>
* 自建接口文档 服务类
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
public interface ApiCustomRequestService extends IService<ApiCustomRequest> {
/**
* 构建目录树
*
* @author 暮光：城中城
* @since 2021-12-22
*/
List<ApiCustomVo> buildCustomApiList(Long docId);
}

20
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/service/manage/impl/ApiCustomFolderServiceImpl.java Normal file
View File

@@ -0,0 +1,20 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.zyplayer.doc.data.repository.manage.entity.ApiCustomFolder;
import com.zyplayer.doc.data.repository.manage.mapper.ApiCustomFolderMapper;
import com.zyplayer.doc.data.service.manage.ApiCustomFolderService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
/**
* <p>
* 自建接口文档文件夹 服务实现类
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
@Service
public class ApiCustomFolderServiceImpl extends ServiceImpl<ApiCustomFolderMapper, ApiCustomFolder> implements ApiCustomFolderService {
}

96
zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/service/manage/impl/ApiCustomRequestServiceImpl.java Normal file
View File

@@ -0,0 +1,96 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.zyplayer.doc.data.repository.manage.entity.ApiCustomFolder;
import com.zyplayer.doc.data.repository.manage.entity.ApiCustomRequest;
import com.zyplayer.doc.data.repository.manage.mapper.ApiCustomRequestMapper;
import com.zyplayer.doc.data.repository.manage.vo.ApiCustomDocVo;
import com.zyplayer.doc.data.repository.manage.vo.ApiCustomVo;
import com.zyplayer.doc.data.service.manage.ApiCustomFolderService;
import com.zyplayer.doc.data.service.manage.ApiCustomRequestService;
import org.apache.commons.collections.CollectionUtils;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
/**
* <p>
* 自建接口文档 服务实现类
* </p>
*
* @author 暮光：城中城
* @since 2021-12-22
*/
@Service
public class ApiCustomRequestServiceImpl extends ServiceImpl<ApiCustomRequestMapper, ApiCustomRequest> implements ApiCustomRequestService {
@Resource
ApiCustomRequestService apiCustomRequestService;
@Resource
ApiCustomFolderService apiCustomFolderService;
@Override
public List<ApiCustomVo> buildCustomApiList(Long docId) {
// 查询api列表
QueryWrapper<ApiCustomRequest> wrapper = new QueryWrapper<>();
wrapper.eq("doc_id", docId);
wrapper.eq("yn", 1);
List<ApiCustomRequest> apiCustomList = apiCustomRequestService.list(wrapper);
Map<Long, List<ApiCustomRequest>> apiMap = apiCustomList.stream().collect(Collectors.groupingBy(ApiCustomRequest::getFolderId));
// 查询分组列表
QueryWrapper<ApiCustomFolder> groupWrapper = new QueryWrapper<>();
groupWrapper.eq("doc_id", docId);
groupWrapper.eq("yn", 1);
List<ApiCustomFolder> apiCustomGroupList = apiCustomFolderService.list(groupWrapper);
Map<Long, List<ApiCustomFolder>> apiGroupMap = apiCustomGroupList.stream().collect(Collectors.groupingBy(ApiCustomFolder::getParentFolderId));
List<ApiCustomFolder> apiCustomGroups = apiGroupMap.get(null);
if (CollectionUtils.isEmpty(apiCustomGroups)) {
return Collections.emptyList();
}
return this.getCustomGroupChildren(apiCustomGroups, apiGroupMap, apiMap);
}
/**
* 递归获取目录树
*
* @author 暮光：城中城
* @since 2021-12-22
*/
private List<ApiCustomVo> getCustomGroupChildren(List<ApiCustomFolder> apiCustomGroups, Map<Long, List<ApiCustomFolder>> apiGroupMap, Map<Long, List<ApiCustomRequest>> apiMap) {
if (CollectionUtils.isEmpty(apiCustomGroups)) {
return Collections.emptyList();
}
List<ApiCustomVo> apiCustomVoList = new LinkedList<>();
for (ApiCustomFolder customGroup : apiCustomGroups) {
List<ApiCustomRequest> apiCustomList = apiMap.get(customGroup.getId());
List<ApiCustomFolder> children = apiGroupMap.get(customGroup.getId());
List<ApiCustomVo> customGroupChildren = this.getCustomGroupChildren(children, apiGroupMap, apiMap);
ApiCustomVo apiCustomVo = new ApiCustomVo();
apiCustomVo.setName(customGroup.getFolderName());
apiCustomVo.setDesc(customGroup.getFolderDesc());
apiCustomVo.setChildren(customGroupChildren);
if (CollectionUtils.isNotEmpty(apiCustomList)) {
List<ApiCustomDocVo> apis = new LinkedList<>();
for (ApiCustomRequest apiCustom : apiCustomList) {
ApiCustomDocVo apiCustomDocVo = new ApiCustomDocVo();
apiCustomDocVo.setApiUrl(apiCustom.getApiUrl());
apiCustomDocVo.setApiName(apiCustom.getApiName());
apiCustomDocVo.setBodyData(apiCustom.getBodyData());
apiCustomDocVo.setCookieData(apiCustom.getCookieData());
apiCustomDocVo.setFormData(apiCustom.getFormData());
apiCustomDocVo.setHeaderData(apiCustom.getHeaderData());
apis.add(apiCustomDocVo);
}
apiCustomVo.setApis(apis);
}
apiCustomVoList.add(apiCustomVo);
}
return apiCustomVoList;
}
}

5
zyplayer-doc-data/src/main/resources/mapper/manage/ApiCustomFolderMapper.xml Normal file
View File

@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zyplayer.doc.data.repository.manage.mapper.ApiCustomFolderMapper">
</mapper>

5
zyplayer-doc-data/src/main/resources/mapper/manage/ApiCustomGroupMapper.xml Normal file
View File

@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zyplayer.doc.data.repository.manage.mapper.ApiCustomGroupMapper">
</mapper>

5
zyplayer-doc-data/src/main/resources/mapper/manage/ApiCustomMapper.xml Normal file
View File

@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zyplayer.doc.data.repository.manage.mapper.ApiCustomMapper">
</mapper>

5
zyplayer-doc-data/src/main/resources/mapper/manage/ApiCustomRequestMapper.xml Normal file
View File

@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zyplayer.doc.data.repository.manage.mapper.ApiCustomRequestMapper">
</mapper>