你还在使用swagger？试试这个吧

最新推荐文章于 2024-04-28 09:51:01 发布
最新推荐文章于 2024-04-28 09:51:01 发布
阅读量488 收藏 1
点赞数
文章标签： java intellij-idea 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/beishangbuzailai/article/details/128232022
版权

文章目录

easyyapi插件使用
1. 安装插件

打开idea的Settings–>Plugins,查找easyyapi插件安装。
在这里插入图片描述

2. 配置插件

安装成功后，再次打开Settings–>OtherSettings,配置yapi服务地址以及项目token.
tokens: 项目名=token
在这里插入图片描述

token从项目设置里获取
在这里插入图片描述

3. 编写javadoc

配置完成后，可参考官方demo，编写javadoc。
官方说明地址：https://easyyapi.com/documents/java_doc_demo.html
该插件目前仅支持springweb原生注解，获取控制器的请求方式，自定义注解不支持
在这里插入图片描述

4. 上传接口javadoc

编写完成后，选中要上传的Controller，下拉idea code选项，选择ExportYapi
在这里插入图片描述

也可选择单个接口上传，右键
在这里插入图片描述

执行结果:
在这里插入图片描述

5. 登录YApi,查看项目接口

在这里插入图片描述
在这里插入图片描述

BeiShangBuZaiLai
关注
不想用 Swagger？可以试试这个神器！
芋艿V
11-26 423
点击上方“芋道源码”，选择“设为星标”管她前浪，还是后浪？能浪的浪，才是好浪！每天 8:55 更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2020 超神之路，很肝~...
你还在手动维护接口文档吗，快来试试Swagger2吧!
程序猿小龙的博客
07-20 453
文章目录你还在手动维护接口文档吗，快来试试Swagger2吧!1、Swagger2简单介绍2、SpringBoot整合Swagger22.1、引入依赖2.2、设置Swagger2配置类2.3、访问页面 你还在手动维护接口文档吗，快来试试Swagger2吧! 1、Swagger2简单介绍   现在前后端分离逐渐成为了Web项目的一种标准开发方式，就是前端和后端由不同的人员开发，前端人员负责前端的项目开发，后端人员负责后端项目的开发。但是与此同时，项目开发的沟通成本也随之升高。主要在于前后端人员对于WebApi
还在使用Swagger吗，快来试试这款强大的在线API工具
纯洁的微笑
11-22 302
将开源小分队设为星标精品文章第一时间读大家好，我是可爱又机灵的开源小妹。今天给大家分享一个非常好用的在线文档工具：Knife4j背景现在分工越来越明确，做项目也都是前后端分离，这样就和前...
还在手动维护API文档吗？是时候用用丝袜哥（swagger）了！
hundred_li_journey的博客
09-11 384
在现在微服务满天飘的年代，一个稍微大点的项目就可能有10几个服务，每个服务会产生很多API互相调用，如果没有一个自动生成API文档的工具，那就有的搞了！ Swagger是一个简单但功能强大的API表达工具。它具有地球上最大的API工具生态系统，数以千计的开发人员，使用几乎所有的现代编程语言，都在支持和使用Swagger。使用Swagger生成API，我们可以得到交互式文档，自动生成代码的SDK以及API的发现特性等。 来体验一把吧！ Swagger 使用swagger能帮我们生成API文档，那么它会生.
EasyYapi插件—快速生成API接口文档
Java笔记
05-16 2025
Preferences → Plugins → Marketplace → 搜索“EasyYapi” → 安装该插件 → 重启IDE。使用下面的方式获取token信息，并配置在idea中。EasyYapi插件—快速生成API接口文档。2.2.1 postman请求。生成postman的token。2.2.2 Yapi请求。2.2 idea配置。
idea-easyYapi的使用
soldier_jw的博客
05-11 1096
链接:网上搜到的easyYapi基本上都是千篇一律，比较浅，稍微有点定制的东西都搜不到，帮此把自己的一些心得写出来，后续有新发现也会继续更新。
Yapi神器EasyYapi和MybatisPlus工程整合使用附配置文件
Java Developer Blog
06-23 2049
EasyApi支持检索项目代码中的注释，注解等信息，自动生成接口文档。 本文主要介绍 EasyApi 的使用和 Mybatis-Plus 及其分页插件 Page 与 EasyApi 整合后，接口文档出现问题的解决方案。
还在用Swagger（丝袜哥）生成接口文档？我推荐你试试它......zip
12-13
计算机技术、IT咨询、人工智能AI理论介绍，学习参考资料 计算机技术、IT咨询、人工智能AI理论介绍，学习参考资料 计算机技术、IT咨询、人工智能AI理论介绍，学习参考资料 计算机技术、IT咨询、人工智能AI理论介绍，...
spring-boot-starter-swagger：自制的swagger 2.x弹簧启动器，来试试吧，很好用哦〜
01-30
在该项目的帮助下，我们的Spring Boot可以轻松的约会sswagger2，主需要做下面两个步骤： 在pom.xml中约会依赖： < groupId>com.spring4all</ groupId> < artifactId>swagger-spring-boot-starter < version>...
还在用HttpUtil？试试这款优雅的HTTP客户端工具吧，跟SpringBoot绝配
GTH07399的博客
03-04 188
我们平时开发项目时，就算是单体应用，也免不了要调用一下其他服务提供的接口。此时就会用到HTTP客户端工具，之前一直使用的是Hutool中的HttpUtil，虽然容易上手，但用起来颇为麻烦！最近发现一款更好用的HTTP客户端工具Retrofit，你只需声明接口就可发起HTTP请求，无需进行连接、结果解析之类的重复操作，用起来够优雅，推荐给大家！ 简介 Retrofit是适用于Android和Java且类型安全的HTTP客户端工具，在Github上已经有39k+Star。其最大的特性的是支持通过接口.
IDEA插件系列-EasyYapi
rambler_kieran的博客
04-28 2145
IDEA插件系列-EasyYapi。
EasyYapi接入简单实战
calm_encode的博客
12-07 5855
一 EasyYapi 部署EasyYapi: 参考：Yapi&easyapi文档管理平台安装与使用_程序男的专栏-CSDN博客_easyyapihttps://blog.csdn.net/u010504064/article/details/112055903 二 IDEA 安装Easy Yapi插件 三 配置Yapi的Token 获取Token: 配置Token: ​​ ...
【YAPI】【IDEA】java接口直接导出为YAPI接口文档
锥栗的博客
10-09 6343
本文主要阐述如何通过easyhapi插件快速导出Java接口为YAPI文档。注：YAPI 是一个高效、易用、功能强大的可视化接口管理平台，主要用于 API的开发、测试和文档管理。它提供了一个直观的界面来创建、编辑和删除接口，使得开发者可以方便地管理项目的各种 API。平台内置了自动化测试工具，允许用户编写和执行测试用例，以确保 API 的正确性和稳定性。YAPI 支持数据 Mock 功能，可以在开发过程中模拟后端服务的响应，帮助前端开发者独立进行开发和调试。
YApi的简单使用以及和swagger的接口同步
cpuxiansheng的博客
10-15 6860
Nacos知识什么是NacosNacos 的关键特性包括服务发现和服务健康监测动态配置服务动态 DNS 服务服务及其元数据管理如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入导出导入 什么是Nacos Nacos是用于发现、配置、管理微服务，构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服
SpringBoot使用EasyYapi对代码0侵入实现API接口一键发布到YApi的进阶使用 - 第423篇
qq_44600824的博客
09-27 966
SpringBoot使用EasyYapi对代码0侵入实现API接口一键发布到YApi的进阶使用 - 第423篇
Swagger如此难用，你们竟然还在用？
isFuong的博客
08-09 2209
随便一个接口文档管理工具都能秒杀Swagger，更别提接口文档管理工具中的佼佼者YApi了，接下来就来对比下二者的优缺点。 关于Swagger 遇到的问题 在想要联调接口时，如果接口还没发布甚至还没开发，则需要等待接口开发完成后才能进行联调 对于开发接口的人员，想要生成一份接口文档，需要先引入swagger的jar包，在定义接口时，需要额外编写大量注解及参数。在接口开发完成并发布上线前，对于其他人来说该接口定义是完全不可见的，只能等待！ 当接口开发完成后，如果需要添加一些备注及说明，只能修改项.
Easy Yapi插件使用详情
哆啦A梦
09-23 1318
你还手动在Yapi创建接口吗，如果是，那么你应该好好读读这片文章，对你提高工作效率，很有帮助
SpringBoot使用EasyYapi对代码0侵入实现API接口一键发布到YApi - 第422篇
qq_44600824的博客
09-27 456
SpringBoot使用EasyYapi对代码0侵入实现API接口一键发布到YApi - 第422篇
Swagger、Rap与Yapi接口管理
qq_43429919的博客
08-11 3466
随着项目的规模上升，投入的人力、资源与开发方式都有着很大的变化，大型的项目一般都会采用前后端分离的开发模式，在这种方式中，如何更好的协作工作是提高效率的关键。 在前后端交互中，主要核心的是接口对接与联调，一个好的接口管理工具必不可少，本文也是基于此对目前使用的几种工具进行分析。 在目前工作的一段时间中，基于公司现在使用的 Rap 接口管理工具存在的一些问题，与现在市面上其他常用的接口管理工具或者平台进行对比，推荐可以转用 Yapi 接口管理平台。......
如何在Spring Boot项目中使用Swagger进行数据查询？
最新发布
09-14
Swagger是一种流行的API开发工具，它可以帮助开发者设计、构建、记录和使用RESTful Web服务。在Spring Boot项目中集成Swagger可以通过以下步骤进行： 1. 添加Swagger依赖项：在项目的`pom.xml`（Maven项目）或`build.gradle`（Gradle项目）文件中添加Swagger相关的依赖项。对于Maven项目，通常添加的是`springfox-swagger2`和`springfox-swagger-ui`依赖。 2. 配置Swagger：创建一个配置类，使用`@Configuration`注解来标识这是一个配置类，然后使用`@EnableSwagger2`注解来启用Swagger。还可以自定义一些Swagger的配置，比如API信息、分组等。 3. 使用Swagger注解：在你的Controller中，使用Swagger提供的注解如`@ApiOperation`、`@ApiResponses`、`@ApiParam`等来增加对API的描述，包括接口的描述、请求参数、响应信息等。 4. 访问Swagger UI：完成以上步骤后，启动Spring Boot应用，然后在浏览器中访问`http://localhost:8080/swagger-ui.html`（假设你的应用运行在8080端口），你可以看到一个交互式的API文档界面。 下面是一个简单的示例代码： ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } @RestController @RequestMapping("/api") @Api(value = "数据查询API", description = "提供数据查询相关的REST API") public class DataController { @ApiOperation(value = "获取数据", notes = "根据ID获取数据详情") @GetMapping("/data/{id}") public ResponseEntity<Data> getDataById(@ApiParam(value = "数据ID", required = true) @PathVariable("id") Long id) { // 这里添加获取数据的逻辑 return ResponseEntity.ok(new Data()); } } ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值