SpringBoot整合Swagger2遇到的问题

需要查看完整教程请移步:http://blog.didispace.com/springbootswagger2/

1.不建议使用2.5.2版本以下的swagger2,对有些服务无法兼容支持 ,例:

            在controller中使用 注入Feign的方式调用eureka服务时

            SpringBoot整合Swagger2遇到的问题

本人使用的是2.7.0的版本


2. swagger2的配置类

    SpringBoot整合Swagger2遇到的问题

    title:为 Swagger ui.html展示的标题

    description:为描述详情

    termsOfServiceUrl :是一个连接地址

    contact:是创建者的详情,包含名称等

    version:为版本号

    apis:这里配置的是你的完整项目名,不能配置错误,不然无法扫描到正确的控制器加载文档


3.SpringBoot整合Swagger2遇到的问题

    在控制层接口上添加注解@ApiOpration 说明这个接口的描述有 value 及 notes 

若有多个参数的情况下,需用注解@ApiImplicitParams({@ApiImplicitParam(),...})说明参数

@ApiImplicitParam 有 name(入参的名字) , value(入参的描述) ,  required(约束) ,dataType(数据类型),ParamType(入参获取方式) 目前已知:属性 path ,实体类 body

SpringBoot整合Swagger2遇到的问题