在spring boot中集成Swagger

Swagger

在spring boot中集成Swagger

新建一个swagger项目

maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

编写配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(Environment environment){

        boolean flag = environment.acceptsProfiles(Profiles.of("dev","test"));

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfo(
                        "Api Documentation",
                        "Api Documentation",
                        "1.0",
                        "",
                        new Contact("yao","",""),
                        "pandown 1.0",
                        "http://www.apache.org/licenses/LICENSE-2.0",
                        new ArrayList()))    //定义ApiInfo
                .enable(flag)   //是否启用sawwger
                .groupName("组名")   //配置分组
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wenyao.swagger.controller"))   //包扫描
                .paths(PathSelectors.ant("/"))  //路径过滤
                .build();
    }


}

@ApiModel和@ApiModelProperty

@ApiModel用于给一个类添加描述名

@ApiModelProperty给属性添加描述

@ApiModel("用户")
public class User {
    @ApiModelProperty("编号")
    private int id;
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}

@ApiOperation和@ApiParam

@RestController
public class HelloController {
    
    @ApiOperation("接口注释")
    @RequestMapping("/hello")
    public String hello(){
        return "hello";
    }

    public String hello2(@ApiParam("参数注释") String var){
        return "hello";
    }
}