Browse Source

集成swagger2

master
陈裕财 4 years ago
parent
commit
84c4010dfd
  1. 5
      xm-core/src/main/java/com/xm/core/ctrl/XmTaskController.java
  2. 18
      xm-core/src/test/java/com/xm/SwaggerConfig.java

5
xm-core/src/main/java/com/xm/core/ctrl/XmTaskController.java

@ -114,13 +114,12 @@ public class XmTaskController {
} }
@ApiOperation( value = "查询xm_task信息列表",notes="listXmTask,条件之间是 and关系,模糊查询写法如 {studentName:'%才哥%'}") @ApiOperation( value = "查询xm_task信息列表",notes="listXmTask,条件之间是 and关系,模糊查询写法如 {studentName:'%才哥%'}")
@ApiGlobalModel(component = XmTask.class, value = "id,name") @ApiGlobalModel(component = XmTask.class, value = "id,name")
@ApiResponses({ @ApiResponses({
@ApiResponse(code = 200,response= XmTask.class,message = "{tips:{isOk:true/false,msg:'成功/失败原因',tipscode:'错误码'},total:总记录数,data:[数据对象1,数据对象2,...]}") @ApiResponse(code = 200,response= XmTask.class,message = "{tips:{isOk:true/false,msg:'成功/失败原因',tipscode:'错误码'},total:总记录数,data:[数据对象1,数据对象2,...]}")
}) })
@RequestMapping(value="/getTask",method=RequestMethod.GET) @RequestMapping(value="/getTask",method=RequestMethod.GET)
public Map<String,Object> getTask( @RequestParam Map<String,Object> xmTask){
public Map<String,Object> getTask( @ApiIgnore @RequestParam Map<String,Object> xmTask){
Map<String,Object> m = new HashMap<>(); Map<String,Object> m = new HashMap<>();
RequestUtils.transformArray(xmTask, "ids"); RequestUtils.transformArray(xmTask, "ids");
RequestUtils.transformArray(xmTask, "skillIds"); RequestUtils.transformArray(xmTask, "skillIds");
@ -468,7 +467,7 @@ public class XmTaskController {
@ApiResponse(code = 200,response=XmTask.class,message = "{tips:{isOk:true/false,msg:'成功/失败原因',tipscode:'错误码'},total:总记录数,data:[数据对象1,数据对象2,...]}") @ApiResponse(code = 200,response=XmTask.class,message = "{tips:{isOk:true/false,msg:'成功/失败原因',tipscode:'错误码'},total:总记录数,data:[数据对象1,数据对象2,...]}")
}) })
@RequestMapping(value="/list",method=RequestMethod.GET) @RequestMapping(value="/list",method=RequestMethod.GET)
public Map<String,Object> listXmTask( @RequestParam Map<String,Object> xmTask){
public Map<String,Object> listXmTask(@ApiIgnore @RequestParam Map<String,Object> xmTask){
Map<String,Object> m = new HashMap<>(); Map<String,Object> m = new HashMap<>();
RequestUtils.transformArray(xmTask, "ids"); RequestUtils.transformArray(xmTask, "ids");
RequestUtils.transformArray(xmTask, "tagIdList"); RequestUtils.transformArray(xmTask, "tagIdList");

18
xm-core/src/test/java/com/xm/SwaggerConfig.java

@ -4,13 +4,11 @@ import io.swagger.annotations.Api;
import org.springframework.beans.factory.annotation.Value; import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.*;
import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.Contact;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.spi.DocumentationType; import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext; import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.spring.web.plugins.Docket;
@ -48,9 +46,15 @@ public class SwaggerConfig {
@Bean @Bean
public Docket customDocket() { public Docket customDocket() {
ParameterBuilder tokenPar= new ParameterBuilder();
List<Parameter> pars=new ArrayList<>();
tokenPar.name("Authorization").description("令牌 格式:【bearer 令牌值】,注意bearer后根一个空格。").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
pars.add(tokenPar.build());
tokenPar.name("accessToken").description("令牌,直接填写令牌值").modelRef(new ModelRef("string")).parameterType("query").required(false).build();
pars.add(tokenPar.build());
Docket docket= new Docket(DocumentationType.SWAGGER_2).select(). Docket docket= new Docket(DocumentationType.SWAGGER_2).select().
apis(RequestHandlerSelectors.any()) apis(RequestHandlerSelectors.any())
.build()
.build().globalOperationParameters(pars)
.apiInfo(apiInfo()).enable(true); .apiInfo(apiInfo()).enable(true);
/* /*
@ -60,7 +64,7 @@ public class SwaggerConfig {
//存储用户必须提交的参数 //存储用户必须提交的参数
List<ApiKey> apikey = new ArrayList(); List<ApiKey> apikey = new ArrayList();
//规定用户需要输入什么参数 //规定用户需要输入什么参数
apikey.add(new ApiKey("token", "token", "token"));
apikey.add(new ApiKey("accesToken", "accesToken", "accesToken"));
docket.securitySchemes(apikey); docket.securitySchemes(apikey);
//以下定义如果用户JWT认证通过则在Swagger中全局有效 //以下定义如果用户JWT认证通过则在Swagger中全局有效

Loading…
Cancel
Save