SpringBoot整合Swagger

Swagger主要是用来生成在线的API接口文档,不需开发人员手动维护.
对接口进行测试
所需依赖坐标

 		
            io.springfox
            springfox-swagger-ui
            2.8.0
        
        
            io.springfox
            springfox-swagger2
            2.8.0
        

添加Swagger在项目中的配置文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.capgemini.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("SpringBoot整合Swagger测试")
                        .description("SpringBoot整合Swagger,详细测试信息......")
                        .version("9.0")
                        .contact(new Contact("ccc","http://www.baidu.com","[email protected]"))
                        .license("The Apache License")
                        .licenseUrl("http://www.baidu.com")
                        .build());
    }
}

@Api 标记当前Controller的功能
@ApiOperation 标记一个方法的作用
@ApiImplicitParam 描述一个参数,可设置默认值,测试的时候免手动输入
@ApiModel 标记JavaBean — @ApiModelProperty标记bean中参数

  • Controller声明API信息
    SpringBoot整合Swagger_第1张图片SpringBoot整合Swagger_第2张图片
  • 参数及方法
    SpringBoot整合Swagger_第3张图片SpringBoot整合Swagger_第4张图片
    Swagger-ui中对接口进行测试
    SpringBoot整合Swagger_第5张图片
    SpringBoot整合Swagger_第6张图片
    访问项目路径+swagger-ui.html查看

你可能感兴趣的:(SpringBoot整合Swagger)