ApiOperation和ApiParam注解依赖的安装和使用以及注意事项说明
ApiOperation和ApiParam注解依赖的安装
如果要使用@ApiOperation注解，需要引入swagger，而不是引入OpenAPI
引入依赖
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>启动类设置注解启动
这样就可以在controller里使用 @ApiOperation 注解了，通过浏览器访问 http://localhost:8088/swagger-ui.html
ApiOperation和ApiParam注解的使用
常用的有
@Api@ApiOperation@ApiParam
Api
ApiOperation和ApiParam
@ApOperation 不是spring自带的注解是swagger里面的 com.wordnik.swagger.annotations.ApiOperation;
详细介绍： @ApiOperation 和 @ApiParam 为添加的Controller接口相关注解，个参数说明如下：
@ApiOperation( value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”；
其他参数可参考源码；
@ApiParam( required = “是否必须参数”, name = “参数名称”, value = “参数具体描述”
其中部分参数可以根据需求增加或者删除
@ApiParam 的使用方式和@RequestParam 有点像, 并且可以像如下这样使用
public DataResult<ZonesEiaPlanPageInfoVO> detail(@RequestParam @ApiParam(name = "id", value = "主键") String id) {}拓展
实际项目中非常需要写文档，提高Java服务端和Web前端以及移动端的对接效率。
由于我们在开发中接口众多而且细节复杂（需要考虑不同的HTTP请求类型，HTTP头部信息，HTTP请求内容等）高质量地创建这份文档本身就是一件复杂的事情。
随着时间的前进和技术的推移，不断修改接口实现的时候都必须同步修改接口文档，而接口文档和代码又处于不同时空的两个地方。
注意事项
如果说打不开那个swagger网页
- 检查是否使用了@EnableSwagger2
- 是否有自定义了api前缀
- 是否有拦截器拦截
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了idea工具栏如何添加快捷图标的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-02-02
全局异常处理是个比较重要的功能,一般在项目里都会用到,这篇文章主要给大家介绍了关于SpringBoot中如何统一接口返回与全局异常处理的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下2021-09-09
这篇文章主要介绍了java中的transient关键字解读,transient关键字的主要作用就是让某些被transient关键字修饰的成员属性变量不被序列化,实际上也正是因此,在学习过程中很少用得上序列化操作,一般都是在实际开发中,需要的朋友可以参考下2023-09-09
maven目前在web上面的使用方式很普遍，而打包的方式也存在很多方式，本文就详细的介绍了三种方式，具有一定的参考价值，感兴趣的可以了解下2021-06-06
这篇文章主要介绍了Java的Struts框架中配置国际化的资源存储的要点解析,针对用户所使用的语言来配置资源文件,需要的朋友可以参考下2016-04-04
SpringBoot+Redis执行lua脚本的5种方式总结
Lua是一种快速、轻量级的脚本语言,广泛应用于各种领域,包括数据库,Redis作为一个内嵌Lua解释器的NoSQL数据库,允许通过Lua脚本在服务器端执行一些复杂的操作,本文给大家介绍了使用SpringBoot Redis执行lua脚本的五种方式,需要的朋友可以参考下2023-11-11
Spring中BeanFactory FactoryBean和ObjectFactory的三种的区别
关于FactoryBean 和 BeanFactory的对比文章比较多，但是对ObjectFactory的描述就比较少，今天我们对比下这三种的区别，感兴趣的朋友跟随小编一起看看吧2023-01-01
前端传过来的时间参数，后端可以自定义时间格式转化使用，这样想转成什么就转成什么。本文将利用自定义注解AOP实现时间参数格式转换，感兴趣的可以了解一下2022-04-04
jsoup是一款基于Java的HTML解析器,它提供了一套非常省力的API,不但能直接解析某个URL地址、HTML文本内容,而且还能通过类似于DOM、CSS或者jQuery的方法来操作数据,所以 jsoup 也可以被当做爬虫工具使用,这篇文章主要介绍了什么是jsoup及jsoup的使用,需要的朋友可以参考下2023-10-10
Java集合之Set、HashSet、LinkedHashSet和TreeSet深度解析
这篇文章主要介绍了Java集合之Set、HashSet、LinkedHashSet和TreeSet深度解析,List是有序集合的根接口,Set是无序集合的根接口,无序也就意味着元素不重复,更严格地说,Set集合不包含一对元素e1和e2 ,使得e1.equals(e2) ,并且最多一个空元素,需要的朋友可以参考下2023-09-09
最新评论