关于api:遥遥领先Eolink-IDEA-插件零代码入侵自动生成接口

3次阅读

共计 3485 个字符,预计需要花费 9 分钟才能阅读完成。

省流版:

Eolink 有 IDEA 插件吗?

有,而且遥遥领先!咱们在一年半之前就公布了,而且性能更丰盛!

IDEA 插件市场搜寻“Eolink Apikit”即可装置应用。

🚀 应用指引: https://plugins.jetbrains.com/plugin/19189-eolink/jie-shao

前不久用户群内有热心用户收回了这样的一个疑难“倡议开发一个零代码入侵的,主动生成接口的 Idea 插件

某个 潜水窥屏 深刻调研用户需要的产品经理看到后一惊,竟然还有开发同学不晓得 Eolink 是国内首家上线 IDEA 插件的商业平台?😢

😢 都怪咱们,跟华为一样 不开发布会就把插件上线了 。Eolink 的 IDEA 收费 插件 早在 2022 年 3 月就曾经上线 IDEA 插件市场了,至今早有一年半的工夫了,咱们的产研团队始终默默更新,遗记通知大家了。

明天给大家从新具体地介绍一下 Eolink Apikit 的 IDEA 插件能力~

Eolink 自 2016 年公布以来, 就始终在 API 全生命周期治理畛域深耕。在整个全生命周期的流程中,首要解决的问题是如何基于已有的历史数据转成标准规范的 API 文档,并在对立的文档仓库中治理起来。

Eolink 很早前就提供 多种生成 API 文档的形式了:

1. 手工录入或导入对应协定文件

反对 HTTP / Websocket / TCP / UDP / HSF / Dubbo / gRPC / SOAP 等

2. 导入其余 API 治理平台数据

反对 Postman / Swagger / Jmeter / Yapi / ApiDoc / HAR / RAP / Apipost / Apifox / ShowDoc 等

3. 基于 Swagger URL 一键同步

4. 基于 git 仓库 URL 一键同步

反对 gitlab / github / gitee 等

5. 基于数据库表生成

反对 MySQL / Oracle / Redis / SQL Server / MongoDB / PostgreSQL / AnalyticDb / MariaDB 等

以上的这些生成 API 文档形式能适配大部分用户的应用场景,对于我的项目初期或者进行大规模数据迁徙时也非常好用。然而在我的项目接口迭代过程中,这些办法就显得有点“轻便”。

对于开发同学来说,无论是新增还是批改接口文档,都须要在开发工具和接口管理工具上同步最新的数据。而且接口文档变更内容会比拟琐碎和频繁。

那么是否有更轻便的同步接口数据形式呢?

咱们提供了一个高效计划:

在开发工具上基于接口代码片段,一键生成 API 文档,反对在开发工具中调试,并可一键上传至 Eolink Apikit 的代码仓库中。

这样不仅能够缩小界面的操作和零碎间的切换,还能够在开发工具上实现琐碎和频繁的接口文档更新,是以后 CODE TO API 的最佳实际

如上图的业务流程展现,后端工程师其所有工作均可通过 IDEA 插件在 IDEA 开发工具中实现,无需跨零碎跨平台,满足频繁零散更新的场景。

在传统的 CODE TO API 场景下,就无奈不聊 Swagger 提供的解决方案了。Swagger 通过事后填写代码注解,而后再通过解析,实现了代码生成 API 文档的能力。

那么比照 Swagger,Eolink Apikit 的 IDEA 插件又有什么劣势呢?

1. 外围区别是无代码侵入

Eolink Apikit 插件与 Swagger 最大的差别在于代码侵入性上。Swagger 的运行机制决定了其须要通过在代码文件中编写注解、配置、形容等信息能力失效,肯定水平上会对代码产生侵入性的影响。

Eolink Apikit 提供的 IDEA 插件计划是 可通过 Java 文件的办法出入参进行解析,主动生成 API 文档的。也就是说能够在不填写任何的注解的状况下,应用 Eolink 的插件生成 API 文档。

2. 兼容多种注解,主动补全

毕竟 Swagger 是寰球热门的传统 API 管理工具,局部旧代码可能曾经编写了 Swagger 注解,对于这些注解 Eolink Apikit 插件也会进行兼容,作为解析接口能力的重要补充信息。

除了对 Swagger 的 V2 版本和 V3 版本注解反对外,咱们 还反对 Spring MVC 注解、JavaDoc 正文、Eolink 正文和 Dubbo 注解,使得插件的适配场景更广。

如果现有的正文不全,插件还会依据对 Java 文件的剖析,主动生成正文进行补全。

3. 更全面的协定反对

Swagger 个别仅反对 HTTP 协定,而 Eolink Apikit 插件除了反对 HTTP 协定外,还反对 Dubbo 和 HSF 协定的上传。并且后续会逐渐拓宽反对更多协定类型。

从 2021 年开始,API 治理畛域呈现了一些新的优良工具,最近一年也有很多用户心愿理解 Eolink Apikit 与市面上其余同类产品能力区别。本文把比照的范畴管制在插件能力给大家一个参考,Eolink Apikit 的 IDEA 插件劣势在哪里?

🚀 全自研插件能力更适配

Eolink Apikit 的 IDEA 插件是 齐全自研 的,于 2022 年 3 月 19 日上线。

插件研发的原因最早是 Eolink 外部某研发线的后端同学本人编写的一些脚本,而后团队投入大量人力进行补全优化成插件,并 外部运行稳固后 上架到插件市场的。通过一年半的工夫,Eolink 的 IDEA 插件曾经取得 超过 17 万下载量 (IDEA 市场同类插件下载量排名第一), 其稳定性、业务适配能力 曾经过大量的企业级开发团队应用和验证。

通过调研,咱们能够发现市面同类产品的插件均是通过“开源插件革新 ”或者“ 开源 + 用户共创”的模式研发而来的。尽管这种开发模式可能很大水平上节俭研发老本以及插件的研发工夫。然而开源插件与自生平台的兼容性问题是不可避免的。

开源插件落后能力与 IDEA 插件新体系的矛盾抵触:

同类插件根本都是从开源插件“easy-api”进行革新上线的,然而 应用“esay-api”革新的插件会面临一个外围问题是拓展能力差。

📌 划重点:

easy-api 开源插件是 18 年公布的第一个版本,并在 19 年 9 月份推出正式版本。而 IDEA 插件体系在 2020 年则进行了一次大变革,大部分外围接口都进行了调整并反对了更多新的能力。

所以用 2020 年前的接口能力来做的“esay-api”插件自身就很难反对更多的能力拓展和更好的应用体验。咱们能够发现“开源魔改”这类型插件始终在改善和优化原开源插件的兼容性问题,这点能够从同类插件的历史更新记录上失去印证。

为什么咱们保持全自研 IDEA 插件?

与开源插件改版而来的 IDEA 插件相比,原生自主研发的插件在拓展能力和兼容能力会更胜一筹,同时也防止了插件能力与业务场景不适配的问题。

绝对采纳开源改版的开发模式而言,纵使全自研后期的研发老本会更大,从 0 开始会更加难,Eolink Apikit 依然抉择走齐全自主研发的产品策略。IDEA 插件的每一行代码都倾泻了研发团队心血,使得咱们的插件能够提供更多的服务和场景能力,真正地帮忙开发者用户晋升 API 研发效力。

咱们把同类 IDEA 插件产品在 IDEA 插件市场的相干数据整顿如下:

Eolink Apikit 的 IDEA 插件 上线工夫最早 用户验证最多 ,并且代码齐全自主研发,在业务适配能力上有短缺公正的第三方平台可视化数据证实,Eolink Apikit 的 IDEA 插件早已在 私有化交付中应用,已被多个研发规模超 10000 人的企业客户验证。

🎉 性能多样更弱小

目前市面上同类插件提供 能力比拟靠近 Swagger,更多的仅仅调整了上传到对应平台的能力;而 Eolink Apikit 不满足于此,咱们提供了更多样的能力反对:

零注解生成 :目前 同类插件 须要编写注解 能力生成 API 文档,无奈反对零注解生成,以及主动生成正文的能力。

RPC 类型接口生成: Eolink Apikit 反对 Dubbo 和 HSF 的协定接口生成,后续还会逐渐反对更多接口协议。

正文拓展: 为了反对更多自定义的场景,Eolink Apikit 插件提供了更多业务拓展正文,能够在设置界面增加自定义正文或兼容现有正文。

多种上传形式: Eolink 关注开发者更多的应用场景,提供残缺我的项目级别扫描上传、新接口定义上传、接口局部变更属性上传等多种不同层级的上传形式,应用更便捷更得心应手。

Eolink Apikit 的 IDEA 插件,是国内商业平台中最早公布的 API 治理插件,代码齐全自主研发,性能多样且平安稳固。

心愿通过本文,能够让大家理解咱们 “未开发布会先上线”IDEA 插件 ,最初,Eolink Apikit 提供的插件是 收费的,更多装置应用阐明能够查阅:https://plugins.jetbrains.com/plugin/19189-eolink/jie-shao

Eolink Apikit 官网:https://www.eolink.com/apikit

正文完
 0