spring boot swagger2 常用整合梳理 单个文件包配置

单个文件包

1.pom.xml 导入swagger2 jar包 

   io.springfox
   springfox-swagger2
   2.8.0



   io.springfox
   springfox-swagger-ui
   2.8.0

2.swaggerConfig 配置文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {
   
    @Bean
    public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("**.controller"))//这里是controller所处的包
                    .paths(PathSelectors.any())
                    .build();

    }
    //构建api文档的详细信息函数
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("页面标题")
                //描述
                .description("api查询测试接口")
                .termsOfServiceUrl("API terms of service")
                .licenseUrl("http//本机IP地址:8080/")
                .version("1.0")//版本号s
                .build();
    }

}

3.controller 实例

@Api(tags = {"接口描述"},description = "详细描述")
@RestController
@RequestMapping("/test")
public class TestController{
    //返回参数描述--注解
    @ApiResponses({@ApiResponse(code = 1,message = "成功"),@ApiResponse(code = 2,message = "error失败")})
    //接口详情描述--注解
    @ApiOperation(value = "接口详情",notes = "接口详情")
    @GetMapping("/dome")
    //请求参数描述--注解
    @ApiImplicitParams({@ApiImplicitParam(name = "code",value = "编号",required = true)})
    public JSONObject getOrderInfoByOrderCode(@RequestParam("code") String code){
        JSONObject json = new JSONObject();
      
        return json;
    }
}

4.可控制生产环境无效方式

    网上查询很多文章没有测试通过，只有用这个笨方法了，在.licenseUrl("http//本机IP地址:8080/") 写死本机地址，生产还地址了就无妨问swagger-ui.thml  有什么好的方法可以留言

5.yml文件配置

-dev.yml -test.yml prod.yml 配置文件信息