Skip to content

8
8timerapiv200
Commit a9a55f64 by tangzhaoqian Committed by chenzg
Options

swagger1.UI优化 2.模块排 3.接口排序

parent 8ab01577
Showing with 117 additions and 52 deletions
pom.xml
......@@ -18,6 +18,7 @@
<properties>
<java.version>1.8</java.version>
<shiro.version>1.2.3</shiro.version>
<swagger.version>2.9.2</swagger.version>
</properties>
<dependencies>
......@@ -66,35 +67,54 @@
</dependency>
<!-- optional这个需要为 true 热部署才有效 -->
<!-- <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId>
<optional>true</optional> </dependency> -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui -->
<!-- swagger2 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
<exclusions>
<exclusion>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
</exclusion>
<exclusion>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- 解决 Illegal DefaultValue null for parameter type integer 异常 -->
<!-- https://mvnrepository.com/artifact/io.swagger/swagger-annotations -->
<!--防止进入swagger页面报类型转换错误，排除2.9.2中的引用，手动增加1.5.21版本 -->
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.22</version>
<version>1.5.21</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.swagger/swagger-models -->
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>1.5.22</version>
<version>1.5.21</version>
</dependency>
<!-- swagger2-UI -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>
<!-- -->
<dependency>
......
src/main/java/cn/timer/api/bean/qyzx/QyzxEmpLogin.java
......@@ -74,7 +74,7 @@ public class QyzxEmpLogin extends Model<QyzxEmpLogin> {
@ApiModelProperty(value="验证码 ",example="666666")
private Integer code;
@ApiModelProperty(value="权限 ",example="['0','1','2']")
@ApiModelProperty(value="权限 ",example="0,1,2")
@TableField(exist = false)
private List<String> menus;
......
src/main/java/cn/timer/api/config/interceptor/WebSecurityConfig.java
......@@ -36,6 +36,8 @@ public class WebSecurityConfig implements WebMvcConfigurer {
registry.addInterceptor(getSessionInterceptor())
.addPathPatterns("/**")
.excludePathPatterns("/doc*")
.excludePathPatterns("/v2/**")
.excludePathPatterns("/**/*.js")
.excludePathPatterns("/8timer/**")
.excludePathPatterns("/kqz/punchclock/**")
.excludePathPatterns("/kqz/sauserregdata/**")
......
src/main/java/cn/timer/api/config/swagger/Swagger2Config.java
package cn.timer.api.config.swagger;
import java.util.ArrayList;
import java.util.List;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration//声明为配置文件，让spring加载
@EnableSwagger2//支持swagger2插件配置
@EnableSwaggerBootstrapUI
@Configuration // 声明为配置文件，让spring加载
@EnableSwagger2 // 支持swagger2插件配置
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger2Config {
// apiInfo对象主要是设置我们api文档的标题，描述，访问的地址，创建者等信息
@SuppressWarnings("deprecation")
@Bean
public ApiInfo apiInfo() {
return new ApiInfoBuilder().title("8小时-Api接口文档").description("快速进行Api接口调试").termsOfServiceUrl("127.0.0.1:8080")
.contact("TangZhaoQian").version("1.0").build();
}
/**
* 创建API
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
// .pathMapping("/dev-api")
// 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
.apiInfo(apiInfo())
// 设置哪些接口暴露给Swagger展示
.select()
//.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
// 扫描所有有注解的api，用这种方式更灵活
// .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
// 扫描指定包中的swagger注解
.apis(RequestHandlerSelectors.basePackage("cn.timer.api"))
.paths(PathSelectors.any())
.build();
// 扫描所有 .apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any()).build()
/* 设置安全模式，swagger可以设置访问token */
.securitySchemes(securitySchemes()).securityContexts(securityContexts());
}
//apiInfo对象主要是设置我们api文档的标题，描述，访问的地址，创建者等信息
@SuppressWarnings("deprecation")
@Bean
public ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("8小时-Api接口文档")
.description("快速进行Api接口调试")
.termsOfServiceUrl("127.0.0.1:8080")
.contact("TangZhaoQian")
.version("1.0")
.build();
/**
* 安全模式，这里指定token通过Authorization头请求头传递
*/
private List<ApiKey> securitySchemes() {
List<ApiKey> apiKeyList = new ArrayList<ApiKey>();
apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
return apiKeyList;
}
/**
* 安全上下文
*/
private List<SecurityContext> securityContexts() {
List<SecurityContext> securityContexts = new ArrayList<>();
securityContexts.add(SecurityContext.builder().securityReferences(defaultAuth())
.forPaths(PathSelectors.regex("^(?!auth).*$")).build());
return securityContexts;
}
//docket容器设置我们的文档基础信息，api包的位置，以及路劲的匹配规则（包含四种：全匹配，不匹配，正则匹配和ant匹配）
// @Bean
// public Docket docket(){
// //return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("cn.timer.api.controller")).paths(PathSelectors.regex("/test/.*")).build();
// return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("cn.timer.api.controller")).paths(PathSelectors.regex("/*/.*")).build();
// }
/**
* 默认的安全上引用
*/
private List<SecurityReference> defaultAuth() {
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
List<SecurityReference> securityReferences = new ArrayList<>();
securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
return securityReferences;
}
}
\ No newline at end of file
src/main/java/cn/timer/api/controller/LoginController.java
......@@ -20,6 +20,7 @@ import org.springframework.web.bind.annotation.RestController;
import com.alibaba.fastjson.JSONObject;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.service.additional.query.impl.LambdaQueryChainWrapper;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import cn.hutool.core.date.DateUtil;
import cn.hutool.core.util.StrUtil;
......@@ -73,6 +74,7 @@ public class LoginController {
*/
@PostMapping(value = "/sendcode")
@ApiOperation(value = "1.发送验证码", httpMethod = "POST", notes = "接口发布说明")
@ApiOperationSupport(order = 1)
public Result<String> sendCode(@RequestBody EntRegisterDto entRegisterDto) {
// 6位随机数验证码
try {
......@@ -121,6 +123,7 @@ public class LoginController {
*/
@PostMapping(value = "/authentication")
@ApiOperation(value = "2.手机号码认证", httpMethod = "POST", notes = "接口发布说明")
@ApiOperationSupport(order = 2)
public Result<String> authentication(@RequestBody EntRegisterDto entRegisterDto) {
String phone = entRegisterDto.getPhone();
Integer code = entRegisterDto.getCode();
......@@ -141,7 +144,8 @@ public class LoginController {
* @throws IOException
*/
@PostMapping(value = "/test")
@ApiOperation(value = "2.测试", httpMethod = "POST", notes = "接口发布说明")
@ApiOperation(value = "3.测试", httpMethod = "POST", notes = "接口发布说明")
@ApiOperationSupport(order = 3)
public void test(HttpServletRequest request, HttpServletResponse res) throws IOException {
res.setHeader("content-type","text/html;charset=UTF-8");
......@@ -173,7 +177,8 @@ public class LoginController {
* @return
*/
@PostMapping(value = "/updatepassword")
@ApiOperation(value = "3.修改密码", httpMethod = "POST", notes = "接口发布说明")
@ApiOperation(value = "4.修改密码", httpMethod = "POST", notes = "接口发布说明")
@ApiOperationSupport(order = 4)
public Result<String> updatepassword(@RequestBody EntRegisterDto entRegisterDto){
String phone = entRegisterDto.getPhone();
......
src/main/java/cn/timer/api/controller/jxgl/AchievementsController.java
......@@ -20,6 +20,7 @@ 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.additional.query.impl.LambdaQueryChainWrapper;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import cn.hutool.core.util.StrUtil;
import cn.timer.api.bean.jxgl.JxglAdminJcsz;
......@@ -49,7 +50,6 @@ import cn.timer.api.utils.Result;
import cn.timer.api.utils.ResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiOperationSupport;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
......
src/main/java/cn/timer/api/controller/kqgl/AttController.java
package cn.timer.api.controller.kqgl;
import java.io.UnsupportedEncodingException;
import java.math.BigDecimal;
import java.text.DateFormat;
import java.text.ParseException;
......@@ -38,6 +37,7 @@ import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.service.additional.query.impl.LambdaQueryChainWrapper;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import cn.hutool.json.JSONObject;
import cn.timer.api.bean.kqgl.AttCalendarAlarm;
......@@ -58,7 +58,6 @@ import cn.timer.api.bean.kqgl.AttendanceWeeklySch;
import cn.timer.api.bean.kqgl.CalendarAlarm;
import cn.timer.api.bean.kqgl.ClockCollectData;
import cn.timer.api.bean.kqgl.CustomRosterSchedule;
import cn.timer.api.bean.kqgl.KqglAssoKqjgly;
import cn.timer.api.bean.kqgl.KqzAttendanceGroupSearch;
import cn.timer.api.bean.kqgl.PunchCardAddress;
import cn.timer.api.bean.kqgl.PunchCardDetails;
......@@ -75,8 +74,6 @@ import cn.timer.api.bean.kqgl.TBlFkcmdTrans;
import cn.timer.api.bean.kqgl.TBlFkcmdTransCmdParam;
import cn.timer.api.bean.kqgl.UserAttendanceRel;
import cn.timer.api.bean.kqgl.UserEquiRelation;
import cn.timer.api.bean.kqjg.KqjgRealtimeEnrollData;
import cn.timer.api.bean.xcgl.XcglAdminXzz;
import cn.timer.api.bean.yggl.YgglMainEmp;
import cn.timer.api.config.Initialization.StaticVariable;
import cn.timer.api.config.annotation.CurrentUser;
......@@ -99,7 +96,6 @@ import cn.timer.api.dao.kqgl.UserEquiRelationMapper;
import cn.timer.api.dao.kqjg.KqjgRealtimeEnrollDataMapper;
import cn.timer.api.dao.yggl.YgglMainEmpMapper;
import cn.timer.api.dto.kqgl.AttemacDto;
import cn.timer.api.dto.kqgl.AttendanceMachineDto;
import cn.timer.api.dto.kqgl.MachinememberDto;
import cn.timer.api.utils.DateUtil;
import cn.timer.api.utils.ResponseResult;
......@@ -107,7 +103,6 @@ import cn.timer.api.utils.Result;
import cn.timer.api.utils.ResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiOperationSupport;
import io.swagger.annotations.ApiParam;
/**
......
src/main/java/cn/timer/api/controller/sbgjj/SocialSecurityFundController.java
......@@ -19,6 +19,7 @@ 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.additional.query.impl.LambdaQueryChainWrapper;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import cn.hutool.core.util.StrUtil;
import cn.timer.api.bean.sbgjj.SbgjjAdminCbry;
......@@ -53,7 +54,6 @@ import cn.timer.api.utils.Result;
import cn.timer.api.utils.ResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiOperationSupport;
@Api(tags = "社保公积金Api")
@RestController
......
src/main/java/cn/timer/api/controller/spmk/SpmkServiceImpl.java
......@@ -18,6 +18,7 @@ import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.ArrayUtil;
......@@ -48,7 +49,6 @@ import cn.timer.api.utils.Result;
import cn.timer.api.utils.ResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiOperationSupport;
@Api(tags = "3.0审批模块")
@RestController
......
src/main/java/cn/timer/api/controller/yggl/YgglController.java
......@@ -34,6 +34,7 @@ import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.additional.query.impl.LambdaQueryChainWrapper;
import com.baomidou.mybatisplus.extension.service.additional.update.impl.LambdaUpdateChainWrapper;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.date.BetweenFormater.Level;
......@@ -86,7 +87,6 @@ import cn.timer.api.utils.Result;
import cn.timer.api.utils.ResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiOperationSupport;
/**
* @date 2019年11月15日
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment