开发一个api文档管理工具:官宣开源
开发一个api文档管理工具:官宣开源其实工作都是这些工作,但将设计的过程提前可以减少很多协作问题。更直观一些,两种协作流程的对比如图:涉及到多人共同协作完成一件事的时候,不应该把设计任务只交给其中的某一个人,应该先交流和沟通,将设计的流程前置,并用文档记录设计的过程和结果。就像开发人员总会吐槽产品文档没写清楚一样,前端人员也会吐槽后端不给文档或者写不清楚,这个问题可以通过引入一个能协作设计并展示清晰的 API 信息的工具(明示 Eoapi)解决。你可以考虑在 Eoapi 尝试采用以下简易的协作流程:
大家好,时隔一个月,我们又又又发布啦,本月的主题是: 团队协作 。
在开发模式是前后端协作的团队里,分享 API 文档信息会是前后端对接过程中重要的一环,我想在这次月报分享下我们工具推荐的开发流程。
知乎上有一个热门问题:后端人员先开发后给文档合理吗?
我认为不合理,换位思考了下在这种开发模式下的前端人员,对接的过程应该蛮痛苦,前端开发的能力和经验决定后续改动代码的痛苦程度。
涉及到多人共同协作完成一件事的时候,不应该把设计任务只交给其中的某一个人,应该先交流和沟通,将设计的流程前置,并用文档记录设计的过程和结果。
就像开发人员总会吐槽产品文档没写清楚一样,前端人员也会吐槽后端不给文档或者写不清楚,这个问题可以通过引入一个能协作设计并展示清晰的 API 信息的工具(明示 Eoapi)解决。
你可以考虑在 Eoapi 尝试采用以下简易的协作流程:
- 设计接口原型,写接口文档;
- 前后端同步写代码,根据文档对接;
- 在对接过程中获得的信息优化接口原型,重复过程。
更直观一些,两种协作流程的对比如图:
其实工作都是这些工作,但将设计的过程提前可以减少很多协作问题。
朋友们,相信我,想通过不写文档节省的时间最终都会在对接扯皮过程中还给我们;而且人多力量大嘛,不同的人有不同的角度,观点碰撞可以让设计更好更全面。
当然,决定在设计过程中投入多少时间和精力是需要根据团队的情况调配的,团队很有默契不用约定也能设计一致,那文档什么时候写就不太重要了,适合自己团队的流程就是最好的。
空间是什么?
我们在这个版本引入了空间的概念,一个空间一般是一个团队,我们可以往空间里添加队友:
加入后就可以一起愉快地共享 API 和环境等空间内数据啦~
想起在月初的时候,有用户恳(wei)请(xie)我们一定一定一定不要做登录的功能,我理解他的核心的诉求其实是打开就能用,别整那么多花里胡哨的。
作为 Eoapi 的产品和开发我想说:放心吧,如果你用不上云端的功能,那就没有登录的必要,在本地空间内尽情使用吧~
如何使用
在服务端运行下面命令使用 Docker 一键启动。
git clone https://GitHub.com/eolinker/eoapi-remote-server
cd eoapi-remote-server
docker-compose up -d --build
在客户端中配置云服务地址点击连接后就可以将数据上传到云端啦。
配置这一块我们设计得十分简单,隐藏了很多配置细节,界面提示可以指引你快速上手新功能。 例如初始化时可以让你选择将本地的数据同步到云端。
后续计划
Web 部署
目前我们都是通过桌面端使用的,有的用户会觉得部署和更新不太方便。 所以我们接下来会推出 Web 版本,方便大家打开浏览器就能使用(我个人更喜欢 Web 应用)~ 其实桌面端有桌面端的好处,方便找,加载快,不需要部署,萝卜青菜各有所爱。
API 分享
正在开发中,相信很快就能在 v1.9.0 和大家见面啦。 使用很简单,一键就可以通过分享链接快速将 API 分享给相关的人员。原型图浅看一下:
获得 GVP
除了新版本发布,还有一个好消息!本月我们的开源项目终于获得了 Gitee 官方的认可,荣获 Gitee 年度最有价值的开源项目称号 ——GVP,谢谢官方的认可!谢谢各位用户的支持!
努力提升用户体验是我们做开源项目的初心 ,尽管我们的项目在 Gitee 上传代码不久,但为了让所有用户能有较好的下载体验, 我们会在后续任何一个新版本发布的第一时间同步 Gitee 。
我们会努力做好项目,也希望我们的项目能继续得到你们的大力支持! 关于项目,如果你有任何的疑问或者建议,老规矩,记得去 Github 或者 Gitee 上提 Issue ,我们会第一时间处理。
在线 Demo : Easy & Open Source API Ecosystem
Github : GitHub - eolinker/eoapi: Eoapi 是一个可扩展的 API 开发工具。Eoapi 集合基础的 API 管理和测试功能,并且可以通过插件简化你的 API 开发工作,让你可以更快更好地创建 API。
Gitee: Eolink/eoapi
本文来源:开源中国
(声明:“开源推荐”刊载此文,是出于传递更多信息之目的。若有来源标注错误或侵犯了您的合法权益,请及时与我们联系,我们将及时更正、删除或依法处理。)