SpringBoot——SpringBoot集成Swagger生成API文档

<!-- swagger依赖 -->
<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>

1.  #开启或关闭Swagger
2.  swagger.enable=true

package com.szh.springboot.controller;
import com.szh.springboot.model.User;
import io.swagger.annotations.*;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
/**
 *
 */
@Api(tags = "SpringBoot集成Swagger2测试")
@Controller
public class SwaggerController {
    @ApiOperation(value = "获取用户信息",notes = "根据id获取用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "path",name = "id",value = "用户ID",dataType = "Integer"),
            @ApiImplicitParam(paramType = "path",name = "name",value = "用户姓名",dataType = "String"),
    })
    @ApiResponses({
            @ApiResponse(code = 200,message = "请求成功"),
            @ApiResponse(code = 400,message = "缺少必要的请求参数"),
            @ApiResponse(code = 401,message = "请求路径没有响应的权限"),
            @ApiResponse(code = 403,message = "请求路径被隐藏不能访问"),
            @ApiResponse(code = 404,message = "请求路径没有或页面跳转路径错误"),
            @ApiResponse(code = 405,message = "请求方法不支持"),
    })
    @RequestMapping(value = "/swagger/queryUser/{id}/{name}",method = RequestMethod.GET)
    public @ResponseBody User getUserInfo(@PathVariable("id") Integer id,
                                          @PathVariable("name") String name) {
        User user=new User();
        user.setId(id);
        user.setName(name);
        user.setPhone("18500000000");
        user.setEmail("szh@163.com");
        return user;
    }
    @ApiOperation(value = "添加用户信息",notes = "将用户信息添加之后保存到数据库")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "body",name = "users",value = "用户对象",dataTypeClass = User.class)
    })
    @ApiResponses({
            @ApiResponse(code = 200,message = "请求成功"),
            @ApiResponse(code = 400,message = "缺少必要的请求参数"),
            @ApiResponse(code = 401,message = "请求路径没有响应的权限"),
            @ApiResponse(code = 403,message = "请求路径被隐藏不能访问"),
            @ApiResponse(code = 404,message = "请求路径没有或页面跳转路径错误"),
            @ApiResponse(code = 405,message = "请求方法不支持"),
    })
    @RequestMapping(value = "/swagger/addUser",method = RequestMethod.POST)
    public @ResponseBody User addUser(@RequestBody User users) {
        return users;
    }
    @ApiOperation(value = "修改用户信息",notes = "将用户信息修改之后保存到数据库")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "body",name = "users",value = "用户对象",dataTypeClass = User.class)
    })
    @ApiResponses({
            @ApiResponse(code = 200,message = "请求成功"),
            @ApiResponse(code = 400,message = "缺少必要的请求参数"),
            @ApiResponse(code = 401,message = "请求路径没有响应的权限"),
            @ApiResponse(code = 403,message = "请求路径被隐藏不能访问"),
            @ApiResponse(code = 404,message = "请求路径没有或页面跳转路径错误"),
            @ApiResponse(code = 405,message = "请求方法不支持"),
    })
    @RequestMapping(value = "/swagger/updateUser",method = RequestMethod.PUT)
    public @ResponseBody User updateUser(@RequestBody User users) {
        return users;
    }
    @ApiOperation(value = "删除用户信息",notes = "将用户信息从数据中删除")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "query",name = "id",value = "用户ID",dataType = "Integer")
    })
    @ApiResponses({
            @ApiResponse(code = 200,message = "请求成功"),
            @ApiResponse(code = 400,message = "缺少必要的请求参数"),
            @ApiResponse(code = 401,message = "请求路径没有响应的权限"),
            @ApiResponse(code = 403,message = "请求路径被隐藏不能访问"),
            @ApiResponse(code = 404,message = "请求路径没有或页面跳转路径错误"),
            @ApiResponse(code = 405,message = "请求方法不支持"),
    })
    @RequestMapping(value = "/swagger/deleteUser",method = RequestMethod.DELETE)
    public @ResponseBody Object deleteUser(@RequestParam("id") Integer id) {
        return "成功删除了id为 " + id + " 的用户";
    }
}

package com.szh.springboot.config;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
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;
/**
 *
 */
@EnableSwagger2 //开启对Swagger2的支持
@Configuration //声明当前类是一个配置类
public class SwaggerConfig {
    @Value("${swagger.enable}")
    private Boolean swaggerEnable;
    //在Spring容器中配置一个Bean对象
    @Bean
    public Docket docket() {
        //链式编程（构建器模式），基本是固定
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(swaggerEnable)
                .apiInfo(apiInfo())
                .select()
                //扫描带有ApiOperation注解的所有方法，为它们生成API接口文档
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    //创建api的基本信息，自定义即可
    private ApiInfo apiInfo() {
        //链式编程（构建器模式），基本是固定
        return new ApiInfoBuilder()
                .title("用户信息中心接口文档")
                .description("SpringBoot集成Swagger2构建RESTful APIs")
                .termsOfServiceUrl("https://blog.csdn.net/weixin_43823808")
                .contact(new Contact("张起灵","https://blog.csdn.net/weixin_43823808","张起灵@163.com"))
                .version("1.0.0")
                .build();
    }
}