导入依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
新ui,直接可以配headers
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
配置类:
package com.gkl1120.topicmq.conf;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.Contact;
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;
import java.util.ArrayList;
import java.util.List;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.pathMapping("/")
.select()
.apis(RequestHandlerSelectors.basePackage("com.gkl1120.topicmq.controller"))
.paths(PathSelectors.any())
.build().apiInfo(new ApiInfoBuilder()
.title("SpringBoot整合Swagger")
.description("SpringBoot整合Swagger,详细信息......")
.version("1.0")
.contact(new Contact("gklTest","blog.csdn.net","1430490717@qq.com"))
.license("The Apache License")
.licenseUrl("http://www.baidu.com")
.build())
.securitySchemes(securitySchemes())
.securityContexts(securityContexts())
;
}
private List<ApiKey> securitySchemes() {
List<ApiKey> apiKeyList= new ArrayList();
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;
}
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;
}
}
package com.hikvision.ostore.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMethod;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.builders.ResponseMessageBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.ResponseMessage;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.Arrays;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
Docket createRestApi() {
ResponseMessage requestParameterError = new ResponseMessageBuilder().code(400).message("Request Parameter Error").build();
ResponseMessage notFound = new ResponseMessageBuilder().code(404).message("Not Found").build();
ResponseMessage internalServerError = new ResponseMessageBuilder().code(500).message("Internal Server Error").build();
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.hikvision.ostore.web.controller"))
.paths(PathSelectors.any())
.build()
.pathMapping("/")
// 以字符串代替日期格式显示
.directModelSubstitute(LocalDate.class, String.class)
.directModelSubstitute(LocalDateTime.class, String.class)
.genericModelSubstitutes(ResponseEntity.class)
// 页面显示信息
.apiInfo(apiInfo())
.enable(true)
// 设置全局自定义异常消息返回
.useDefaultResponseMessages(false)
.globalResponseMessage(RequestMethod.GET, Arrays.asList(requestParameterError, notFound, internalServerError))
.globalResponseMessage(RequestMethod.POST, Arrays.asList(requestParameterError, internalServerError))
.globalResponseMessage(RequestMethod.PUT, Arrays.asList(requestParameterError, internalServerError))
.globalResponseMessage(RequestMethod.OPTIONS, Arrays.asList(requestParameterError, internalServerError))
.globalResponseMessage(RequestMethod.DELETE, Arrays.asList(requestParameterError, internalServerError));
}
private ApiInfo apiInfo() {
return new ApiInfo("swagger2 API",
"swagger2 API 文档",
"1.0.0",
"/",
new Contact("swagger2 API文档", "/doc.html", ""),
"",
"",
new ArrayList<>());
}
}
package com.gkl1120.topicmq.dto;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
* @author ctx_gao kailong
* @date 2020/5/25 15:02
*/
@Data
@ApiModel
public class SendDTO {
@ApiModelProperty(value = "路由键")
private String key;
@ApiModelProperty(value = "消息")
private String msg;
}
package com.gkl1120.topicmq.controller;
import com.gkl1120.topicmq.dto.SendDTO;
import com.gkl1120.topicmq.service.Productr;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.Map;
/**
* @author ctx_gao kailong
* @date 2020/5/22 16:26
*/
@RestController
@RequestMapping("/mq")
@Api(tags = "主题模式mq相关接口")
public class MqController {
@Autowired
private Productr productr;
@ApiOperation("发送mq消息")
@PostMapping("/send")
public String send(@RequestBody SendDTO sendDTO) {
productr.send(sendDTO.getMsg() , sendDTO.getKey());
return "ok";
}
@ApiOperation("发送mq消息1")
@GetMapping("/send1")
@ApiImplicitParams({
@ApiImplicitParam(name = "msg", value = "消息", defaultValue = "haha"),
@ApiImplicitParam(name = "key", value = "路由键", defaultValue = "test", required = true)
})
public String send1(String msg , String key) {
productr.send(msg , key);
return "ok";
}
}
访问地址:
http://localhost:8080/swagger-ui.html
(端口号与当前项目端口号一致)