关于api:从今天起不再为生成-API-烦恼

35次阅读

共计 3463 个字符,预计需要花费 9 分钟才能阅读完成。

做技术治理的童鞋,往往会陷入这样一种窘境:疲于奔命,到处救火填坑,沟通推动,却挤不出工夫思考对团队和我的项目来说真正重要的事件。

你有没有经验过这样的场景:

  1. 上司老是改了接口但不保护文档,屡说不改;
  2. 后端改了接口没有及时告诉前端和测试,导致上游环节的共事来投诉;
  3. 因为团队每个角色应用的工具不同,工具之间的数据又无奈兼容互通,导致一些共用的数据,每个人却要本人反复去创立、复制一遍;而一旦呈现批改,每个人又要到不同软件再改一遍;
  4. 新共事入职,工具入门门槛高,导致上手艰难且迟缓

如果在你的项目组里,这样的情况重复产生,那么有必要考虑一下这个团队研发效力工具——Eolink Apikit

Apikit 是联合 API 设计、文档治理、自动化测试、监控、研发治理和团队合作的一站式 API 生产平台,从集体开发者到跨国企业用户,Apikit 帮忙寰球超过 50 万开发者和 10 万家企业更快、更好且更平安地开发和应用 API。

一、既是单兵作战工具,又是团队合作神器

它确实做得很好。是单兵作战和团队合作都做得十分杰出那种。

1.1 在单兵作战上

如果你是后端,那么 Eolink Apikit 的可视化接口设计和接口、文档一体化性能比 swagger 更容易上手和保护;

它还能操作数据库,反对 30 多种编程语言 , 调用内部函数和脚本,反对继续集成,调试性能比 Postman 更齐备;

如果你是前端,那么 Apikit 的智能 mock 引擎可用于一键 mock 出实在业务数据;

如果你是测试,那么 Apikit 的用例主动生成能够让你高效执行自动化测试;

1.2 在团队合作上

如果你在一个团队里,那么整个团队只须要应用 Apikit 一个工具,一个我的项目只须要一套接口数据,就能实现接口开发 – 接口文档治理 – 接口调试 – 接口自动化测试 – 接口保护 – 版本迭代 等一整个 API 研发流程和 API 从设计到上线的生命周期治理。

二、后端角色:文档治理、接口测试

2.1 可视化接口设计

和 swagger 须要通过编写代码造成接口页面不同,Apikit 只须要填写申请参数、申请办法,响应参数、增加接口阐明就能生成一份接口文档。

接口可间接进入调试环节,或者间接生成业务代码,同时也可进入下一环节,给前端调试页面,测试执行接口测试。

2.2 文档与接口一体化

接口和文档应用同一个工具,一旦接口有批改和迭代,文档能够同步更新保护,防止因为文档和接口拆散造成保护不及时的状况。

三、前端角色:智能 Mock

3.1 最强 Mock API 能力

在瀑布流开发模式中,如果前端开发人员须要进行页面对接,须要后端先实现 API 的开发工作,因而前后端开发的进度会相互影响。通过 Mock API,您能够当时编写好 API 的数据生成规定,由 API 研发治理平台 动静生成 API 的返回数据。开发人员通过拜访 Mock API 来取得页面所须要的数据,实现对接工作。

Eolink 提供市面最强的 Mock API 能力体系:

如果用户仅须要疾速的基于接口文档中的返回后果获取对应的随机数据,则能够通过 繁难 Mock 性能 获取对应信息。

如果用户冀望通过一个 url 模仿不同的申请信息时,获取对应个的返回后果模仿数据,则举荐应用 高级 Mock 性能。

3.2 高级 Mock

高级 Mock API 反对依据不同的申请参数返回不同的 HTTP Status Code、Header、Body 等数据。您能够在一个 API 文档里创立多个高级 Mock API,模仿前端发动的各种申请,不便对前端逻辑进行校验。当我的项目正式公布时,只需将高级 Mock API 的地址前缀替换为理论的拜访地址即可。

3.3 繁难 Mock

繁难 Mock 性能可在编写 API 文档的时候,同时对不同的返回后果进行 Mock 配置。并且可预置智能 Mock 规定,在编写返回参数时,若参数名和字段类型匹配智能 Mock 规定时,零碎主动填入该参数的 Mock 规定。配置繁难 Mock 后,API 文档会主动生成 Mock URL,用户可复制该 URL 间接调用得出想要的数据后果。

体验链接:
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy15

四、测试角色:自动化测试

4.1 主动生成用例

在 Apikit 的自动化测试利用中,所有的测试用例都是以我的项目维度来进行治理,一个自动化测试项目能够从多个 API 文档我的项目中援用 API 信息来创立 API 测试用例。

进入用例治理页面,点击 增加用例 按钮,在弹窗中输出测试用例的名称,而后点击确定:

进入流程测试用例详情页,点击增加测试步骤,在下拉菜单中抉择 从 API 文档新建 API 测试。

4.2 创立定时测试工作

API 自动化测试能够设置定时工作,实现我的项目在无人值守的状况下自动测试并且发送报告给相应的邮箱,监控我的项目监控状况。

次要性能有:

  1. 容许对测试工作进行分组,最大反对二级分组;
  2. 测试工作反对设置循环条件:永恒、仅执行一次;
  3. 测试工作周期可为周、日,工夫粒度为每小时;
  4. 能够从已有的用例中抉择测试用例;
  5. 反对设置测试环境;
  6. 反对测试实现后通过邮件发送后果;

4.3 生成测试报告

进入测试报告页面,在这里会列出所有手动批量测试、定时测试、Open api 测试的测试报告。在定时测试报告列表,你能够在这里抉择某次测试工作,顺次点击查看详情 – 全副。在弹出的 HTML 页面可查看具体记录该次测试报告的所有信息。

用户查看测试报告详情时,能够编写测试总结。例如测试背景,测试指标以及测试后果剖析。

测试报告反对下载和在线分享,以及邮件发送,邮件会将测报告概括内容主动带入到邮件注释中。用户收到邮件后,能够点击测试概括内容跳转到在线测试报告。

体验链接:
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy15

五、团队合作:API 全生命周期管理工作流

作为一个单兵作战的利器,它有优于传统工具的体现,但它能做的事件不止于此。实际上是,互联网倒退了这么久,工具始终在新陈代谢,但第一次,有一个工具彻底买通了从接口设计、文档治理、前端调试,接口自动化的整个接口研发流程;可能笼罩到从接口设计,到批改、保护、版本迭代的接口全周期的治理。开发和测试再也不必吃力巴拉地 —— 写接口文档用 swagger,接口调试用 postman,页面调试用 mock.js,测试用 Jmeter,一遍遍地导入甚至手动复制接口数据到这些工具中。

合作才是 Eolink Apikit 真正的杀手锏。我的项目接口数据零散散布在不同工具中,由不同人员把握,往往造成迭代一时爽,沟通修罗场,保护火葬场。而应用 Eolink,一个工具,一份我的项目接口数据,团队每个角色参加其中,各取所需。

后端用它来做文档治理和接口设计,前端用它来调试页面,测试用它来做自动化,雷同的参数字段只用写一次,其他人用到间接调用。雷同的接口只需写一次,各端都能共享。雷同的用例只需写一次,就能搭积木般结构出测试用例。因为不须要应用多个工具,也就缩小了工具切换和数据导入等反复工作所节约的工夫;因为应用同一套数据源,一旦接口数据产生变更,数据能及时同步更新到各端,不须要另外告知、由上游环节的童鞋本人手动去批改。

5.1 旧我的项目轻松迁徙

大家手头上必然还有一些经年的我的项目在保护,想要迁徙到 Apikit 里也很简略,目前反对多达 20 种格局的接口数据导入,足以实现无缝导入,一键迁徙。

5.2 丝滑的团队合作

在线分享 & 导出,版本治理与评论,让跨团队合作更晦涩。可在线分享 API 文档或导出为离线文件,不便开发合作;对 API 信息进行版本治理,可任意切换、比照版本,理解改变内容;可对 API 文档发表评论,评论会依照版本进行归类;

剖析统计报表,API 治理状况和盘托出。针对 API 设置各类自定义标签,如 API 的开发状态、负责人等信息。零碎会主动主动统计并生成报表,不便您随时理解我的项目情况;

反对多层级我的项目权限治理,反对自定义角色与权限能够依据部门、项目组对我的项目进行治理,独自设置某个我的项目的操作权限,并且能够自行定义每个角色的权限。满足企业合规和平安的需要;

5.3 收费应用

Eolink Apikit 的免费版曾经反对十分弱小的性能,足够集体开发者和小团队治理和合作应用。如有进阶需要,可思考购买付费版,当然性价比也很高。

总结

总的来说,Eolink Apikit 十分弱小,弱小的文档治理,高级 Mock API 能力,自动化测试,高效的合作和欠缺的权限治理,强烈推荐大家应用。

体验链接:
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy15

正文完
 0