springboot 整合 swagger2 自动维护接口文档

1.pom.xml依赖 

   <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
         <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.7.3</version>
        </dependency>

    </dependencies>

 

2.swagger 配置

@Configuration
@EnableSwagger2
public class SwagerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 自行修改为自己的包路径
                .apis(RequestHandlerSelectors.basePackage("com.bowei.swagger.web"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("api文档")
                .description("restfun 风格接口")
                //服务条款网址
                //.termsOfServiceUrl("http://blog.csdn.net/forezp")
                .version("1.0")
                //.contact(new Contact("帅呆了", "url", "email"))
                .build();
    }

}

3.编写接口配合使用注解 @API

@Api(value="/test",tags="测试接口")
@Controller
@RequestMapping("/test")
public class RestController {
    
     @ApiOperation(value="展示首页信息")
     @RequestMapping("/show")
    public String test1(@ApiParam("测试id")String id){
        return "SUCCESS";
    }
     @ApiOperation(value="实体类接受参数")
     @RequestMapping("/test2")
     public String test2(Request request){
         return "SUCCESS";
     }

}
 

@ApiModel("request")
public class Request {
@ApiModelProperty("用户id")    
private String id;
@ApiModelProperty("用户名字")    
private String name;
public String getId() {
    return id;
}
public void setId(String id) {
    this.id = id;
}
public String getName() {
    return name;
}
public void setName(String name) {
    this.name = name;
}

}
4.访问接口文档地址 loaclhost:8080/swagger-ui.html

     欢迎大家关注我的微信公众号 您的关注就是我不懈的动力