swagger2整合springboot

1.导入pom文件：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
      <version>2.2.2</version>
  </dependency>
  <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.2.2</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-core-asl</artifactId>
    <version>1.9.13</version>
</dependency>

2.编写配置文件：

@Configuration
@EnableSwagger2
public class Swaggers {
    @Bean
    public Docket swaggerSpringMvcPlugin() {
        ApiInfo apiInfo = new ApiInfo("sample of springboot", "sample of springboot", null, null, null, null, null);
        Docket docket = new Docket(DocumentationType.SWAGGER_2).select().paths(regex("/user/.*")).build()
                .apiInfo(apiInfo).useDefaultResponseMessages(false);
        return docket;
    }
    /*private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("测试API")
                .description("樊亚的测试API11")
                .version("1.0.0")
                .build();
    }*/
    /* @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.didispace.web"))
                    .paths(regex("/user/.*"))
                    .build();
        }
    */
}

3.利用注解编写Controller接口

@RestController
@RequestMapping("/user")
@Api(value = "Shop")
public class SpringBootController {
    @ApiOperation(value = "获取helloWorld", notes = "简单请求")
    @RequestMapping("/")
    String home() {
        return "HELLO WORLD";
    }
    @ApiOperation(value = "获得A+B", notes = "根据url的classNo和url的studentName获得请求参数的字符串相加，RestFul风格的请求")
    @ApiImplicitParams({@ApiImplicitParam(name = "classNo", value = "班级编号",paramType = "path",dataType = "String")
    })
    @RequestMapping(value = "/class/{classNo}/to/{studentName}", method = RequestMethod.GET)
    String world(@PathVariable("classNo") String classNo, @PathVariable("studentName") String studentName) {
        System.out.println(classNo + " " + studentName);
        return classNo + "  " + studentName;
    }
}

4.启动后就可以通过访问地址http://localhost:8080/swagger-ui.html/，就可以在浏览器看到接口的信息。

最常用的5个注解

@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiProperty：用对象接收参数时，描述对象的一个字段

其它若干

@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API