前端、后端、测试,一份API文档就够了!

作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色。但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,比如:API 文档定义、API 自动化测试等等,这些工作都是不同的角色、涉及不同的工具,沟通协作占据了大量的时间和精力。

现状:

后端常使用Swagger管理 API 文档、用Postman做调试,测试人员用JMeter做API自动化测试。开发过程中接口有变更需要与多端同步、联调时还会有各种问题,这就导致维护不同工具之间数据一致性非常困难、低效。

需求:

所以,能有一份联合各端的通用的API文档,就尤为重要。而Apipost,主要就是解决不协调的问题,让开发人员通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!

对比:

针对API文档,我们可以对比一下Apipost与传统API文档、常用的Swagger之间的区别,更便于你选择适合自己的API管理工具:

1、统API文

很多团队的API文档依然在使用传统方式,即手动写一份类似于Word、excel的文档,将需要传递的数据填入,发给团队需要的成员,每次需要改动时都改好文件后再发送一次。对于后端人员来说,需要花大量的时间去专注于写文档;而Apipost,开发过程中调试完接口就能自动生成API文档,无需另外花时间去单独写。

2、Swagger文档

先来看看swagger与Apipost生成的API文档界面对比:

【Swagger-API文档界面】


【Apipost-API文档界面】


可以直观的看到,Apipost界面展示信息很全,左侧有菜单栏可以看到项目信息,中间是详细接口信息,包括项目/接口列表、基本接口信息(创建人、创建时间、更新时间,以及接口开发进度、状态、认证方式等)、参数、响应示例等;而且是纯中文界面,让人一看就很明白,想知道的信息都会展示在文档里。

而swagger的文档就展示了基本的API信息,接口列表也是平铺展示,想看单独的某个接口也没有菜单栏可以快速定位,只能手动一个一个去找;而且界面中很多都是英文,不太适合新人小白去上手和学习。

【Swagger-API详细信息界面】


超越:

1、分享/导出文档

Apipost在分享API文档时还可以自定义分享,包括上传logo、设置密码查看、文档有效期、内外网分享等。

【Apipost-API文档分享界面】


Swagger 要分享API文档首先需要导出文件,而导出却需要对应的插件和依赖包,比较繁琐复杂。而Apipost支持导出HTML、word和markdown格式的API文档,并且可还以一键去调试,快速定位接口问题,不需要多种工具来回切换。

【Apipost-API文档快捷调试和导出界面】


2、归档管理

还有就是,Apipost生成的API文档虽然可以实时同步,但是开发人员并不是任何时候都想同步给别人。比如开发完的接口自己想改参数进行调试等,没必要或者不想同步给其他人员,怎么办呢?可以设置归档,接口被归档后,已经分享出去的文档就不会随着自己的改动而改变,自己修改接口信息时就不会同步给其他人了。

所以,无论小白还是职场老油条,Apipost都是值得去用的一款API管理工具。下至0基础小白上手就可以使用,上至行业专家可以高效协同管理团队并节省研发时间。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,542评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,822评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,912评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,449评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,500评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,370评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,193评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,074评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,505评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,722评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,841评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,569评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,168评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,783评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,918评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,962评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,781评论 2 354

推荐阅读更多精彩内容