SpringBoot框架—SpringBoot集成swagger2

SpringBoot框架—SpringBoot集成swagger2

---

1.在pom.xml中导入依赖

<!-- swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2.编写SwaggerConfig类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     * @return: Docket
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.accp.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return: ApiInfo
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2")
                .description("更多请关注http://www.baidu.com")
                .termsOfServiceUrl("http://www.baidu.com")
                .build();
    }

}

3.使用Restful风格编写Controller

@RestController
@RequestMapping("login")
public class LoginController {

    @Autowired
    private UserService userService;

    @Autowired
    private Result result;

    @ApiOperation(value="查询",notes = "查询用户列表")
    @GetMapping("findUser")
    public Result findUser() {
        List<User> user = userService.findUser();
        result.setCode(1);
        result.setMsg("success");
        result.setData(user);
        return result;
    }

    @ApiOperation(value="删除",notes = "删除用户")
    @DeleteMapping("del/{redisKey}")
    public void del(@PathVariable String redisKey) {
        userService.delCache(redisKey);
    }
}

4.启动项目访问Swagger—ui

基于HEXO搭建的个人博客,欢迎访问 https://starbuck.top(初次访问有些慢，请耐心等待一会会儿)