spring-boot集成swagger2并进行分组
项目文件结构
src
├─main
| ├─java
| | ├─com
| | | ├─cisbest
| | | | ├─demo
| | | | | ├─DemoApplication.java
| | | | | ├─web
| | | | | | ├─controller
| | | | | | | └UserWebController.java
| | | | | ├─config
| | | | | | └SwaggerConfig2.java
| | | | | ├─app
| | | | | | ├─controller
| | | | | | | └UserAppController.java
swagger配置(SwaggerConfig2.java)
package com.cisbest.demo.config;
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.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig2 {
@Bean
public Docket docketWeb() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("web端")
.select()
.apis(RequestHandlerSelectors.basePackage("com.cisbest.demo.web.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo("web端"));
}
@Bean
public Docket docketApp() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("app端")
.select()
.apis(RequestHandlerSelectors.basePackage("com.cisbest.demo.app.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo("app端"));
}
private ApiInfo apiInfo(String title) {
return new ApiInfoBuilder()
.title(title)
.description("接口文档描述")
.contact(new Contact("氵灬","https://www.cnblogs.com/cisbest/","cisbest@163.com"))
.version("v1.0")
.license("Apache2.0")
.licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
.build();
}
}
web端(UserWebController.java)
package com.cisbest.demo.web.controller;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Api(tags = "用户管理")
@RestController
@RequestMapping("/web")
public class UserWebController {
@ApiOperation(value = "查询用户", notes = "根据id查询用户")
@ApiImplicitParam(paramType = "path",name = "id",value = "用户id",required = true)
@GetMapping("/user/{id}")
public String getUserById(Integer id){
return "/user/" + id;
}
}
app端(UserAppController.java)
package com.cisbest.demo.app.controller;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Api(tags = "用户管理")
@RestController
@RequestMapping("/app")
public class UserAppController {
@ApiOperation(value = "查询用户", notes = "根据id查询用户")
@ApiImplicitParam(paramType = "path",name = "id",value = "用户id",required = true)
@GetMapping("/user/{id}")
public String getUserById(Integer id){
return "/user/" + id;
}
}
项目依赖
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.3.RELEASE</version>
<relativePath/>
</parent>
<dependencies>
<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>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
</dependencies>
访问swagger
本地访问swagger:http://localhost:8080/swagger-ui.html,
通过swagger-bootstrap-ui美化后的本地访问地址:http://localhost:8080/doc.html
参考:
http://springfox.github.io/springfox/docs/current/#configuring-springfox
开发工具
浙公网安备 33010602011771号