用Swagger-UI实现在线API文档

用Swagger-UI实现在线API文档

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,可以动态地根据注解生成在线API文档。

一、常用注解(有四种)
(1)@Api:用于修饰Controller类,生成Controller相关文档信息,在controller类的开头
用Swagger-UI实现在线API文档_第1张图片
(2)@ApiOperation:用于修饰Controller类中的方法,生成接口方法相关文档信息,在方法的前面
用Swagger-UI实现在线API文档_第2张图片
(3)@ApiParam:用于修饰接口中的参数,生成接口参数相关文档信息,在所修饰参数的后面
用Swagger-UI实现在线API文档_第3张图片
(4)@ApiModelProperty:用于修饰实体类的属性,当实体类是请求参数或返回结果时,直接生成相关文档信息
用Swagger-UI实现在线API文档_第4张图片
二、如何使用这个插件
(1)在pom文件中,引入相关依赖


                    

你可能感兴趣的:(工具及中间件)