knife4j(swagger的本地增强解决方案)
1首先引入依赖,在pom.xml引入,引入完成后记得重新加载一下。
引入不成功的话换一个版本
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
<version>4.0.0</version>
</dependency>
2依赖注入完成后,配置yml文件
application.yml或者application.propertie,自己的配置不动,加入下面的代码
knife4j:
enable: true #此项必配置,否则knife4j运行有问题
3
在Controller类和方法上使用
序列 | 注解 | 作用 |
---|---|---|
1 | @Api(tags = “Knife4jController接口类”) | |
2 | @Api | 修饰整个类,描述api(Controller)的作用 |
3 | @ApiOperation | 描述一个类的一个方法,或者说一个接口 |
4 | @ApiImplicitParam | 多个请求参数的描述信息 |
5 | @ApiImplicitParam(name = “name”,value=“请求的名称”,required = true) | 单个参数的描述信息 |
6 | @ApiIgnore | 使用该注解忽略这个API |
7 | @ApiError | 发生错误返回的信息 |
`` |
4在页面输入你的配置文件中的地址加上端口号/doc.html,你就可以进入使用了
例子
在controller层使用的例子
使用swagger的例子