【⼯具】⽬前⼏种常见的线上接⼝⽂档管理平台的⽐较
⽂章⽬录
⼀、前⾔
作为⼀个公司的技术部门,就会涉及到⼀些⽂档的对接,包括但不仅局限于
需求⽂档
会议记录
接⼝⽂档
切图标注
对接的部门,包括但不仅局限于
前端和后端
移动端和后端
设计和前端
设计和移动端
产品经理和开发
⽼板和产品经理
那么,在这些沟通中产⽣的⽂档,该怎么保存、归档,该怎么阅读、使⽤,就成了团队协作提升沟通效率中重要的⼀个环节。
接下来,我列举了⼀些⼯具,供开发⼈员和项⽬管理⼈员选择,根据⾃⼰的实际情况选出对应的解决⽅案。
⼆、接⼝⽂档在线平台
这⾥处理的问题是前端和后端交互,产⽣的⼀些接⼝⽂档,这些⽂档格式统⼀,但变更很快,并且修改之后看起来并不明显,如果开发团队有异地协作和远程办公,沟通⼜是个问题。
1.apizza
apizza的定位是api协作管理⼯具 ,官⽹地址为 apizza/
他的⾸页是这样的
实际使⽤界⾯是这样的
emmmm,实际上就是⼀个线上版本的Postman…
有⼏个亮点功能,如果你正好需要的话,可以酌情加分~
1.1 ⽂档导出html
导出的样⼦是这样的
很⽅便前端和移动端的同学阅读,不知道⽐那些word⽂档强到哪⾥去了~ 1.2 导⼊Postman.json和Swagger.json⽂件
如果团队内使⽤了Postman或者Swagger的话,就会让操作更加连贯。如果可以导出对应的⽂件就好了~
2. YApi
YApi旨在为开发、产品、测试⼈员提供更优雅的接⼝管理服务。可以帮助开发者轻松创建、发布、维护 API 上的特性如下
网站源码在线
他的界⾯是这样的
好吧,貌似开源的项⽬并不是都很好看…
2.1 源码开源&免费&⽀持⼆次开发
注意的是,这个项⽬是开放源代码的,也就意味着更安全,更可维护,你可以直接去反馈bug,让他做的更好。项⽬地址为 github/ymfe/yapi
2.2 [只能]内⽹部署
项⽬开源带来的好处就是可以⾃⼰部署到内⽹上,保证数据的安全性。
同时YApi不提供公共的版本供⼤家注册使⽤,也就是需要我们⾃⼰的团队必须去部署。
2.3 ⽀持⾃动化测试
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论