springboot项目使用Swagger自动生成api文档

1. 增加依赖
   最好用2.7，之前用的2.4发现在pramters下面没有相应的属性，没有办法输入相关的值（好坑）。

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

2. Swagger配置类

@Configuration
@EnableSwagger2
public class Swagger {

    /**
     * @Description:swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("com.miaoshaw.miaoshawdemo.controller"))//这是controller层所在的包
                .paths(PathSelectors.any()).build();
    }

    /**
     * @Description: 构建 api文档的信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置页面标题
                .title("秒杀API文档")
                // 设置联系人
                .contact(new Contact("name", "url", "email"))
                // 描述
                .description("文档描述信息")
                // 定义版本号
                .version("1.0").build();
    }
}

3. 给相关的Controller增加相关的注解

@Api表示标识这个类是swagger的资源 value是解释

@Controller
@RequestMapping("/Login")
@Api(value = "用户登录接口",tags = {"登录的controller"})
public class LoginController {

4. 给每个接口起名字
   @ApiOperation 表示一个http请求的操作

    @ApiOperation(value = "登录")
    @RequestMapping("/do_login")
    @ResponseBody
    public Result<Boolean> doLogin(HttpServletResponse response,@Valid LoginVo loginVo) {

5. 给接口传递的参数
   在实体类上加上相应的注解

• @ApiModel()用于类
  表示对类进行说明，用于参数用实体类接收
• @ApiModelProperty()用于方法，字段
  表示对model属性的说明或者数据操作更改

@ApiModel(value = "登录vo",description = "这是用户对象 ")
public class LoginVo {
    @NotNull
    @IsMobile
    @ApiModelProperty(value = "用户名",dataType = "String",required = true)
    private String mobile;

    @NotNull
    @Length(min = 32)
    @ApiModelProperty(value = "密码",dataType = "String",required = true)
    private String password;