1.pom.xmlhtml
<!--swagger2--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> <exclusions> <exclusion> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> </exclusion> </exclusions> </dependency> <!--下面的不添加會致使訪問報404--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency> <!--swagger2密碼--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency>
application.properties添加swagger訪問密碼:
security.basic.enabled=true
security.basic.path=/swagger-ui.html
security.user.name=admin
security.user.password=123456
2.swagger配置類spring
參考:http://blog.didispace.com/springbootswagger2/api
3.生成離線文檔:springboot
使用springfox-staticdocs生成swagger離線api文檔附帶源碼app
4.項目使用demo:spring-boot
responseMessages.add(new ResponseMessageBuilder().code(999).message("未知異常").responseModel(new ModelRef(error)).build());
return
new Docket(DocumentationType.SWAGGER_2).
apiInfo(buildApiInfo())
.tags(new Tag("tag1", "接口類描述1"),
new Tag("tag2", "接口類描述2")).
select().
apis(RequestHandlerSelectors.
basePackage(swaggerBasePackage)).
paths(PathSelectors.any()).
build()
.useDefaultResponseMessages(false)
.globalResponseMessage(RequestMethod.GET, responseMessages)
@Api(tags = {"tag1"}) @RestController @RequestMapping(value = "test") public class ResourceApi { //...some code... /** * @author Jill */ @PostMapping @ApiOperation("查詢資源列表接口") public Response<Object> getInfoList(@RequestBody @Valid @ApiParam(name = "查詢條件", value = "查詢條件") SearchVO vo) {