java前后端接口(SpringBoot 优雅整合Swagger Api 自动生成文档)

java前后端接口(SpringBoot 优雅整合Swagger Api 自动生成文档)

各位老铁们好,相信很多人对java前后端接口都不是特别的了解,因此呢,今天就来为大家分享下关于java前后端接口以及java前后端接口的问题知识,还望可以帮助大家,解决大家的一些困惑,接下来一起来看看吧!



整合swagger api#

这里我们自己去整合swagger api比较麻烦,要导入好几个包,有大神帮我们写好了轮子kinfe4j直接对应SpringBoot的启动项,而且在不影响原来使用功能上界面ui做了美化功能做了增强 我们直接整合这个就好了

正如官网所说

kinfe4j官方文档点击这里

自定义配置信息#

为我们为swagger配置更多的接口说明

抽出api文档配置模版信息为属性文件方便复用

java前后端接口(SpringBoot 优雅整合Swagger Api 自动生成文档)

在你的Controller上添加swagger注解

@Slf4j@Api(tags = "登录")public class LoginController { private final IUsersService userService; @PostMapping("/login") @ApiOperation("用户登录") public String login(@RequestBody UserLoginParams userLoginParams) { Users u = userService.login(userLoginParams); return "ok"; }}

注意如启用了访问权限,还需将swagger相关uri允许匿名访问

/swagger**/**/webjars/**/v3/**/doc.html

重启服务,自带api文档访问链接为/doc.html界面如下:

相比较原来界面UI更加漂亮了,信息更完善功能更强大

Swagger常用注解#

Api标记#

用在请求的类上,表示对类的说明,也代表了这个类是swagger2的资源

tags:说明该类的作用,参数是个数组,可以填多个。value="该参数没什么意义,在UI界面上不显示,所以不用配置"description = "用户基本信息操作"ApiOperation标记#

用于请求的方法上表示一个http请求的操作

value用于方法描述notes用于提示内容tags可以重新分组(视情况而用)ApiParam标记#

用于请求方法上对请求参数,字段说明;表示对参数的添加元数据(说明或是否必填等)

name–参数名value–参数说明required–是否必填ApiModel标记#

用于java实体类上表示对类进行说明,用于参数用实体类接收

value–表示对象名description–描述

都可省略ApiModelProperty标记#

用于方法,字段; 表示对model属性的说明或者数据操作更改

用于请求类或者方法上,可以不被swagger显示在页面上

ApiImplicitParam标记#

用于方法表示单独的请求参数

ApiImplicitParams标记#

用于方法,包含多个 @ApiImplicitParam

name–参数名value–参数说明dataType–数据类型paramType–参数类型example–举例说明

如果你还想了解更多这方面的信息,记得收藏关注本站。

文章版权声明:除非注明,否则均为边学边练网络文章,版权归原作者所有

相关阅读

最新文章

热门文章

本栏目文章