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前缀
- 是否有拦截器拦截
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
对于并发执行，Java中的CountDownLatch是一个重要的类。为了更好的理解CountDownLatch这个类，本文将通过例子和源码带领大家深入解析这个类的原理，感兴趣的可以学习一下2022-10-10
Springboot升级到2.7.2结合nacos遇到的坑及解决
这篇文章主要介绍了Springboot升级到2.7.2结合nacos遇到的坑及解决,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-06-06
这篇文章主要介绍了SpringBoot @NotBlank错误的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-08-08
这篇文章主要介绍了Java多线程 乐观锁和CAS机制，乐观锁是对于数据冲突保持一种乐观态度，操作数据时不会对操作的数据进行加锁,需要的朋友可以参考下2021-10-10
这篇文章主要介绍了Java高级特性之反射机制,结合实例形式详细分析了Java反射机制原理、功能、使用方法及相关操作注意事项,需要的朋友可以参考下2018-08-08
SpringMVC 提供了强大的数据验证机制，可以方便地验证表单提交的数据，除了自带的验证器之外，SpringMVC 还支持自定义验证器，允许开发者根据业务需求自定义验证规则，本文将介绍如何在 SpringMVC 中使用自定义验证器2023-07-07
Java利用Dijkstra和Floyd分别求取图的最短路径
本文主要介绍了图的最短路径的概念，并分别利用Dijkstra算法和Floyd算法求取最短路径，最后提供了基于邻接矩阵和邻接表的图对两种算法的Java实现。需要的可以参考一下2022-01-01
Java中,ByteArrayInputStream类是实现内存级别的字节流读取的工具,可以从字节数组中读取数据,这个类位于java.io包中,继承自InputStream,ByteArrayInputStream的主要特点有：在内存中操作,不涉及磁盘IO,可以重用流读取数据2024-09-09
这篇文章主要介绍了java如何使用正则表达式限制特殊字符的个数，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-11-11
这篇文章主要介绍了springboot实现Java阿里短信发送代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-02-02
最新评论