让swagger2界面更好看

 

目录

界面对比

原生界面

swagger-bootstrap-ui样式

knife4j样式

后端

后端集成knife4j

后端使用

前端使用

访问地址

---

 

界面对比

原生界面

• 首先看一下swagger2.7.0的原生界面

swagger-bootstrap-ui样式

• swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目

knife4j样式

• Knife4j的前身是swagger-bootstrap-ui

 

---

后端

后端集成knife4j

1. pom文件添加依赖（多模块应添加到模块下的pom中去）

     <dependency>
               <groupId>com.github.xiaoymin</groupId>
               <artifactId>knife4j-spring-ui</artifactId>
               <version>2.0.8</version>
    </dependency>

    

     2..版本号可以访问网址查看具体信息（推荐swagger2使用对应2版本的knife4，亲测无bugj）https://doc.xiaominfo.com/knife4j/documentation/

 

后端使用

• 注解大全

https://zhuanlan.zhihu.com/p/49996147

• controller类注解

@Api(tags = "人员管理")

• 方法注释

 @ApiOperation(value = "查询人员信息")
 @ApiImplicitParams({
            @ApiImplicitParam(name = "endDate", value = "结束时间", paramType = "query", dataType = "String"),
            @ApiImplicitParam(name = "personType", value = "人员类型", paramType = "query", dataType = "int"),
            @ApiImplicitParam(name = "teamId", value = "班组id", paramType = "query", dataType = "int"),
            @ApiImplicitParam(name = "direction", value = "进出方向", paramType = "query", dataType = "int"),
            @ApiImplicitParam(name = "temperatureType", value = "温度情况", paramType = "query", dataType = "int"),
            @ApiImplicitParam(name = "personName", value = "人员名称", paramType = "query", dataType = "String")
    })

• 如果使用了dto，需要用到的注解

• dto需添加到方法返回值类型中去（因此需要返回方法支持泛型，不然swagger的响应示例则会为空）

---

前端使用

访问地址

http://ip:port/xxx/doc.html