swagger和springboot的整合

swagger和springboot的整合

1.加入maven的依赖

    io.springfox
    springfox-swagger2
    2.7.0


    io.springfox
    springfox-swagger-ui
    2.7.0

2.创建Swagger2配置类

1. 通过@Configuration 让spring来加载该配置类

2. 通过@EnableSwagger2 来启动Swagger2
3. 再通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("it.search.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("毕设API")
                .description("毕设的API")
                .termsOfServiceUrl("。。。。。。。。。")
                .contact("matteo")
                .version("1.0")
                .build();
    }
}

3.添加内容

​ 为controller添上对应的注解

     
    @ApiOperation(value = "用户注册", notes = "用户注册")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Successful — 请求已完成"),
            @ApiResponse(code = 500, message = "服务器不能完成请求")
    })
    @RequestMapping(value = "", method = RequestMethod.POST)
    public RestResponse register(
            @ApiParam(value = "注册用户信息", required = true)
            @Valid @BeanParam UserRegister user
    ) {
      
    }

启动springboot 访问链接即可localhost:8082/swagger-ui.html