介绍
Api2Code
是一款可以把 Api 文档 转换为 指定代码 的 浏览器插件。
Api2Code
诞生的初衷是为了帮助开发人员根据接口文档快速地生成 指定语言 接口定义,从而提高开发效率,达到为企业提高人效的目的。
目前支持哪些接口平台?
Api2Code
目前支持 两款 市面上主流接口平台:YApi
、Swagger
。
提示
如果你有对接其他接口平台的需求,请 联系作者 或 给作者提issue在新窗口打开。
支持输出哪些编程语言?
Api2Code
目前支持输出 一门 编程语言:TypeScript在新窗口打开。
即将支持: Java
提示
如果你有输出其他编程语言的需求,请 联系作者 或 给作者提issue在新窗口打开。
它是如何工作的?
Api2Code
目前支持的接口平台(YApi
、Swagger
),都是使用 json-schema在新窗口打开 存储接口信息的。
故 Api2Code
借助了一些社区开源库(如:json-schema-to-typescript在新窗口打开),从而实现了 接口文档 向 指定编程语言 的转换。
为何要重复造轮子
诚然,目前市面上已经有了一些工具实现了 接口文档 向 编程语言 的功能(🙏 感谢这些伟大的程序员为开源社区做出的贡献)。
然后这些工具要么已经年久失修、要么仅支持某一种单一的接口平台、要么代码侵入性强、要么界面老旧交互体验不佳。
Api2Code
遵循 轮子是拿来用的,不是拿来造的
的原则,站在前辈的肩膀上(参考了市面上主流实现方案),旨在为开源社区贡献一份绵薄之力,为广大程序员同仁提供便利。
为何是浏览器插件
目前市面上一些主流的交互方式为:
- 【配置繁琐,无法修改】直接在项目中生成目标代码
- 【缺少注释】根据
mock json
,生成对应代码 - 【代码入侵度高,老代码无能为力】各大全家桶框架内部集成
Api2Code
本着 即插即用,用完即走 的原则,充分发挥浏览器插件的优势,致力于打造 极致轻量级 的 代码生成工具,具备 零配置、随意修改、信息完整、零代码入侵 的特点。