vscode-yapi-接口文档高效工具

以前 vscode-yapi 插件发布的时候,显得有些仓促,文档也都没有,给使用者形成了一些困惑,如今把文档补上了,按我以前的意愿实现了大部分功能,今天正好从新分享一下。前端

首先在这里很是感谢yapi团队对openapi的支持,才有了今天vscode-yapi的出现。其实我刚开始本只想作成公司内部的插件,后面作着作着本身心想既然有它的价值,为什么不把它作成vscode-yapi插件发布出去。
git

vscode-yapi 是基于 vscode extension + yapi openapi 开发的一款接口文档高效工具
github

vscode-yapi 文档地址:lisiyizu.github.ioapi

vscode-yapi 更新日志:github.com/lisiyizu/vs…浏览器

开发 vscode-yapi 的目的:工具

  • 统一前端团队在接口定义的规范
  • 提高接口文档的可维护性
  • 提高前端团队对接接口文档的效率

vscode-yapi 的功能以下:学习

  • 插件设置:yapi配置主题设置项目token管理
  • 模板设置:参数模板api模板
  • 接口文档:光标定位接口,右键直接查看接口文档
  • 管理中心:跨项目的去勾选,快速生成api模板定义
  • 快速生成模板代码:快速直接生成模板代码

vscode-yapi 功能界面以下:spa

插件设置界面插件


模板设置界面
3d


接口文档界面


管理中心界面


快速生成模板代码


截止到目前为止,vscode-yapi 发布有20 天了,很高兴已经有一些人去使用它了。目前的安装下载量大概有 115 人次了。最新版本已经更新到 v1.1.5了。


开发插件不赚钱彻底是为了交个朋友


对于前端开发来讲,接口联调的时间占据了咱们大部分的时间,每当想起咱们来回的从浏览器 和 IDE之间来回切换接口文档的时候。这种体验我就感受有点痛苦,首先这个是有点浪费时间,影响工做效率,其次作的也都是来回的复制粘贴。这种状态让我这种'懒人'萌生了是否能够开发一款 vscode-yapi 插件来解决这个问题。一开始没思路不知道开发一款vscode插件从何入手,本身也没把握这个事情能作成。说到这里要感谢早早聊大会,同时更要感谢一我的,他是早聊二期分享的嘉宾,来自阿里妈妈@崇志。我对他分享的东西印象比较深,他分享了他们团队开发的 vscode-magix 插件,而且开源了(github.com/thx/vscode-…)。vscode-magix 便成了vscode-yapi 的导师和灯塔。在这里建议有想法开发或者学习vscode插件的同窗,能够参考下vscode-magix项目。

安利一下:若是大家公司接口管理平台用的是yapi,而大家前端团队刚好也在用vscode IDE,不妨试一下这个插件。

但愿后续能够有更多有想法的人加入进来一块儿去维护它,一我的的想法毕竟有限。若是你对vscode-yapi 插件有一些想法 或 建议,欢迎入群交流,[vscode-yapi-沟通交流群] QQ群号:1065561413 

若是你以为还能够,欢迎点赞👍👍👍支持、留言评论

笔者正在观望工做机会,本人在北京,有坑位欢迎推荐。

相关文章
相关标签/搜索