swagger文档管理改为API接口文档管理

This commit is contained in:
暮光:城中城
2021-11-26 23:51:14 +08:00
parent 4408525b45
commit 91aef6f9f4
165 changed files with 3892 additions and 5744 deletions

View File

@@ -1,19 +1,21 @@
package com.zyplayer.doc.data.repository.manage.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
/**
* <p>
* swagger文档地址
* api文档地址
* </p>
*
* @author 暮光城中城
* @since 2021-10-15
* @since 2021-11-25
*/
public class SwaggerDoc implements Serializable {
@TableName("api_doc")
public class ApiDoc implements Serializable {
private static final long serialVersionUID = 1L;
@@ -29,7 +31,7 @@ public class SwaggerDoc implements Serializable {
private String name;
/**
* 文档类型 1=url 2=swagger文档json
* 文档类型 1=swagger url 2=swagger json 3=openapi url 4=openapi json 5=自建API分组
*/
private Integer docType;
@@ -39,7 +41,7 @@ public class SwaggerDoc implements Serializable {
private String docUrl;
/**
* swagger文档json内容
* 文档json内容
*/
private String jsonContent;
@@ -165,19 +167,19 @@ public class SwaggerDoc implements Serializable {
@Override
public String toString() {
return "SwaggerDoc{" +
"id=" + id +
", name=" + name +
", docType=" + docType +
", docUrl=" + docUrl +
", jsonContent=" + jsonContent +
", rewriteDomain=" + rewriteDomain +
", openVisit=" + openVisit +
", docStatus=" + docStatus +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
return "ApiDoc{" +
"id=" + id +
", name=" + name +
", docType=" + docType +
", docUrl=" + docUrl +
", jsonContent=" + jsonContent +
", rewriteDomain=" + rewriteDomain +
", openVisit=" + openVisit +
", docStatus=" + docStatus +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
"}";
}
}

View File

@@ -1,19 +1,21 @@
package com.zyplayer.doc.data.repository.manage.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
/**
* <p>
* swagger文档全局参数记录
* api文档全局参数记录
* </p>
*
* @author 暮光城中城
* @since 2021-10-15
* @since 2021-11-25
*/
public class SwaggerGlobalParam implements Serializable {
@TableName("api_global_param")
public class ApiGlobalParam implements Serializable {
private static final long serialVersionUID = 1L;
@@ -38,6 +40,11 @@ public class SwaggerGlobalParam implements Serializable {
*/
private String paramValue;
/**
* 状态 1=启用 2=禁用
*/
private Integer paramStatus;
/**
* 创建人ID
*/
@@ -86,6 +93,13 @@ public class SwaggerGlobalParam implements Serializable {
public void setParamValue(String paramValue) {
this.paramValue = paramValue;
}
public Integer getParamStatus() {
return paramStatus;
}
public void setParamStatus(Integer paramStatus) {
this.paramStatus = paramStatus;
}
public Long getCreateUserId() {
return createUserId;
}
@@ -117,15 +131,16 @@ public class SwaggerGlobalParam implements Serializable {
@Override
public String toString() {
return "SwaggerGlobalParam{" +
"id=" + id +
", paramType=" + paramType +
", paramKey=" + paramKey +
", paramValue=" + paramValue +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
return "ApiGlobalParam{" +
"id=" + id +
", paramType=" + paramType +
", paramKey=" + paramKey +
", paramValue=" + paramValue +
", paramStatus=" + paramStatus +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
"}";
}
}

View File

@@ -1,19 +1,21 @@
package com.zyplayer.doc.data.repository.manage.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
/**
* <p>
* swagger文档请求参数记录
* 文档请求参数记录
* </p>
*
* @author 暮光城中城
* @since 2021-10-15
* @since 2021-11-25
*/
public class SwaggerRequestParam implements Serializable {
@TableName("api_request_param")
public class ApiRequestParam implements Serializable {
private static final long serialVersionUID = 1L;
@@ -23,6 +25,11 @@ public class SwaggerRequestParam implements Serializable {
@TableId(value = "id", type = IdType.AUTO)
private Long id;
/**
* api_doc主键ID
*/
private Long docId;
/**
* 文档url
*/
@@ -75,6 +82,13 @@ public class SwaggerRequestParam implements Serializable {
public void setId(Long id) {
this.id = id;
}
public Long getDocId() {
return docId;
}
public void setDocId(Long docId) {
this.docId = docId;
}
public String getDocUrl() {
return docUrl;
}
@@ -141,17 +155,18 @@ public class SwaggerRequestParam implements Serializable {
@Override
public String toString() {
return "SwaggerRequestParam{" +
"id=" + id +
", docUrl=" + docUrl +
", formData=" + formData +
", bodyData=" + bodyData +
", headerData=" + headerData +
", cookieData=" + cookieData +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
return "ApiRequestParam{" +
"id=" + id +
", docId=" + docId +
", docUrl=" + docUrl +
", formData=" + formData +
", bodyData=" + bodyData +
", headerData=" + headerData +
", cookieData=" + cookieData +
", createUserId=" + createUserId +
", createUserName=" + createUserName +
", createTime=" + createTime +
", yn=" + yn +
"}";
}
}

View File

@@ -0,0 +1,16 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.ApiDoc;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* api文档地址 Mapper 接口
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
public interface ApiDocMapper extends BaseMapper<ApiDoc> {
}

View File

@@ -0,0 +1,16 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.ApiGlobalParam;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* api文档全局参数记录 Mapper 接口
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
public interface ApiGlobalParamMapper extends BaseMapper<ApiGlobalParam> {
}

View File

@@ -0,0 +1,16 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.ApiRequestParam;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* 文档请求参数记录 Mapper 接口
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
public interface ApiRequestParamMapper extends BaseMapper<ApiRequestParam> {
}

View File

@@ -1,16 +0,0 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerDoc;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* swagger文档地址 Mapper 接口
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
public interface SwaggerDocMapper extends BaseMapper<SwaggerDoc> {
}

View File

@@ -1,16 +0,0 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerGlobalParam;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* swagger文档全局参数记录 Mapper 接口
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
public interface SwaggerGlobalParamMapper extends BaseMapper<SwaggerGlobalParam> {
}

View File

@@ -1,16 +0,0 @@
package com.zyplayer.doc.data.repository.manage.mapper;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerRequestParam;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* swagger文档请求参数记录 Mapper 接口
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
public interface SwaggerRequestParamMapper extends BaseMapper<SwaggerRequestParam> {
}

View File

@@ -16,7 +16,7 @@ import java.util.Collections;
public class CodeGenerator {
public static void main(String[] args) {
final String[] tableName = {"swagger_doc"};
final String[] tableName = {"api_doc", "api_request_param", "api_global_param"};
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";

View File

@@ -0,0 +1,17 @@
package com.zyplayer.doc.data.service.manage;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.zyplayer.doc.data.repository.manage.entity.ApiDoc;
import com.baomidou.mybatisplus.extension.service.IService;
/**
* <p>
* api文档地址 服务类
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
public interface ApiDocService extends IService<ApiDoc> {
IPage<ApiDoc> getApiDocList(ApiDoc apiDoc, Integer pageNum, Integer pageSize);
}

View File

@@ -0,0 +1,19 @@
package com.zyplayer.doc.data.service.manage;
import com.zyplayer.doc.data.repository.manage.entity.ApiGlobalParam;
import com.baomidou.mybatisplus.extension.service.IService;
import java.util.List;
/**
* <p>
* api文档全局参数记录 服务类
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
public interface ApiGlobalParamService extends IService<ApiGlobalParam> {
List<ApiGlobalParam> getGlobalParamList();
}

View File

@@ -0,0 +1,16 @@
package com.zyplayer.doc.data.service.manage;
import com.zyplayer.doc.data.repository.manage.entity.ApiRequestParam;
import com.baomidou.mybatisplus.extension.service.IService;
/**
* <p>
* 文档请求参数记录 服务类
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
public interface ApiRequestParamService extends IService<ApiRequestParam> {
}

View File

@@ -1,18 +0,0 @@
package com.zyplayer.doc.data.service.manage;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerDoc;
import com.baomidou.mybatisplus.extension.service.IService;
import java.util.List;
/**
* <p>
* swagger文档地址 服务类
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
public interface SwaggerDocService extends IService<SwaggerDoc> {
public List<SwaggerDoc> getSwaggerDocList(SwaggerDoc swaggerDoc);
}

View File

@@ -1,18 +0,0 @@
package com.zyplayer.doc.data.service.manage;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerGlobalParam;
import com.baomidou.mybatisplus.extension.service.IService;
import java.util.List;
/**
* <p>
* swagger文档全局参数记录 服务类
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
public interface SwaggerGlobalParamService extends IService<SwaggerGlobalParam> {
public List<SwaggerGlobalParam> getGlobalParamList();
}

View File

@@ -1,16 +0,0 @@
package com.zyplayer.doc.data.service.manage;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerRequestParam;
import com.baomidou.mybatisplus.extension.service.IService;
/**
* <p>
* swagger文档请求参数记录 服务类
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
public interface SwaggerRequestParamService extends IService<SwaggerRequestParam> {
}

View File

@@ -0,0 +1,35 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.zyplayer.doc.data.repository.manage.entity.ApiDoc;
import com.zyplayer.doc.data.repository.manage.mapper.ApiDocMapper;
import com.zyplayer.doc.data.service.manage.ApiDocService;
import org.springframework.stereotype.Service;
/**
* <p>
* api文档地址 服务实现类
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
@Service
public class ApiDocServiceImpl extends ServiceImpl<ApiDocMapper, ApiDoc> implements ApiDocService {
@Override
public IPage<ApiDoc> getApiDocList(ApiDoc apiDoc, Integer pageNum, Integer pageSize) {
QueryWrapper<ApiDoc> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("yn", 1);
queryWrapper.eq(apiDoc.getDocType() != null, "doc_type", apiDoc.getDocType());
queryWrapper.eq(apiDoc.getOpenVisit() != null, "open_visit", apiDoc.getOpenVisit());
queryWrapper.eq(apiDoc.getDocStatus() != null, "doc_status", apiDoc.getDocStatus());
queryWrapper.orderByAsc("id");
queryWrapper.select("id", "name", "doc_type", "doc_url", "rewrite_domain", "open_visit", "doc_status", "create_user_id", "create_user_name", "create_time");
IPage<ApiDoc> page = new Page<>(pageNum, pageSize);
return this.page(page, queryWrapper);
}
}

View File

@@ -0,0 +1,29 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.zyplayer.doc.data.repository.manage.entity.ApiGlobalParam;
import com.zyplayer.doc.data.repository.manage.mapper.ApiGlobalParamMapper;
import com.zyplayer.doc.data.service.manage.ApiGlobalParamService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* <p>
* api文档全局参数记录 服务实现类
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
@Service
public class ApiGlobalParamServiceImpl extends ServiceImpl<ApiGlobalParamMapper, ApiGlobalParam> implements ApiGlobalParamService {
@Override
public List<ApiGlobalParam> getGlobalParamList() {
QueryWrapper<ApiGlobalParam> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("yn", 1);
return this.list(queryWrapper);
}
}

View File

@@ -0,0 +1,20 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.zyplayer.doc.data.repository.manage.entity.ApiRequestParam;
import com.zyplayer.doc.data.repository.manage.mapper.ApiRequestParamMapper;
import com.zyplayer.doc.data.service.manage.ApiRequestParamService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
/**
* <p>
* 文档请求参数记录 服务实现类
* </p>
*
* @author 暮光:城中城
* @since 2021-11-25
*/
@Service
public class ApiRequestParamServiceImpl extends ServiceImpl<ApiRequestParamMapper, ApiRequestParam> implements ApiRequestParamService {
}

View File

@@ -1,33 +0,0 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerDoc;
import com.zyplayer.doc.data.repository.manage.mapper.SwaggerDocMapper;
import com.zyplayer.doc.data.service.manage.SwaggerDocService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* <p>
* swagger文档地址 服务实现类
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
@Service
public class SwaggerDocServiceImpl extends ServiceImpl<SwaggerDocMapper, SwaggerDoc> implements SwaggerDocService {
@Override
public List<SwaggerDoc> getSwaggerDocList(SwaggerDoc swaggerDoc) {
QueryWrapper<SwaggerDoc> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("yn", 1);
queryWrapper.eq(swaggerDoc.getDocType() != null, "doc_type", swaggerDoc.getDocType());
queryWrapper.eq(swaggerDoc.getOpenVisit() != null, "open_visit", swaggerDoc.getOpenVisit());
queryWrapper.eq(swaggerDoc.getDocStatus() != null, "doc_status", swaggerDoc.getDocStatus());
queryWrapper.orderByAsc("id");
return this.list(queryWrapper);
}
}

View File

@@ -1,30 +0,0 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerGlobalParam;
import com.zyplayer.doc.data.repository.manage.mapper.SwaggerGlobalParamMapper;
import com.zyplayer.doc.data.service.manage.SwaggerGlobalParamService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* <p>
* swagger文档全局参数记录 服务实现类
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
@Service
public class SwaggerGlobalParamServiceImpl extends ServiceImpl<SwaggerGlobalParamMapper, SwaggerGlobalParam> implements SwaggerGlobalParamService {
@Override
public List<SwaggerGlobalParam> getGlobalParamList() {
QueryWrapper<SwaggerGlobalParam> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("yn", 1);
return this.list(queryWrapper);
}
}

View File

@@ -1,20 +0,0 @@
package com.zyplayer.doc.data.service.manage.impl;
import com.zyplayer.doc.data.repository.manage.entity.SwaggerRequestParam;
import com.zyplayer.doc.data.repository.manage.mapper.SwaggerRequestParamMapper;
import com.zyplayer.doc.data.service.manage.SwaggerRequestParamService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
/**
* <p>
* swagger文档请求参数记录 服务实现类
* </p>
*
* @author 暮光:城中城
* @since 2021-10-15
*/
@Service
public class SwaggerRequestParamServiceImpl extends ServiceImpl<SwaggerRequestParamMapper, SwaggerRequestParam> implements SwaggerRequestParamService {
}