满足您所有 API 需求的开源工具:APIC
API 设计
API 测试
API 文档
是的,你没听错。一个开源工具就能满足你所有的 API 需求。这个工具就是APIC。你可能会觉得,APIC 就是你处理所有 API 所需的工具,这说法有点夸张,那么让我们看看 APIC 是如何兑现这一承诺的。
APIC是一个免费的开源解决方案,可以帮助您进行 API 设计、API 测试(甚至在设计期间)、API 文档、为前端团队模拟 API 响应等。
典型的 API 开发周期包括以下步骤。
- API 设计
- API API开发
- API 测试
- API 集成
APIC 可以帮助您完成每个步骤。让我们从API 设计开始。
API 设计
如果您所在的团队遵循API 开发“设计优先”策略,那么您的 API 生命周期就从 API 设计开始。
在此步骤中,您首先需要使用 Swagger 编辑器(这是广泛接受的标准)为您的 API 定义契约。除非您不喜欢在文本编辑器中编写 API 设计,或者您不熟悉 Swagger 规范。
了解 APIC。借助APIC 的 API 设计器,定义 API 就像填写表单一样简单。API 设计器可以帮助您
-
定义您的 API 端点、请求参数、请求标头和响应模式。更多信息请点击此处
-
定义可重用模型。更多信息请点击此处
-
您甚至可以在 API 设计期间就开始为 API 编写测试。最棒的是,您甚至无需编写任何代码,只需在 UI 上进行测试即可。点击此处了解更多信息。
-
创建一个团队并与大家分享。
现在您的 API 合同已经定义好了,后端团队可以开始开发了,那么前端团队该怎么办呢?他们可以使用APIC 提供的API 模拟器立即开始使用这些 API ,无需等待。
API 测试
如果您在 APIC 中设计了 API,您的团队将自动在API Tester部分测试它们。您的开发人员/测试人员无需再次将其导入(例如 Postman)即可开始测试。
您可以使用 API 测试器执行的操作
- 显然测试你的 API
- 测试 Web Sockets、Socket.io、STOMP 和服务器发送事件 (SSE)
- 使用环境变量在本地、开发、QA、预生产等环境之间切换。
- 根据您的 API 设计进行响应模式验证。
- 直接从响应向您的 API 添加测试,或者如果您想获得更多技术,请使用Chai.js 来编写测试。
- 创建测试项目和测试套件来测试各种 API 场景并导出测试报告。
- 使用apic-cli将您的测试套件添加到您的 CI/CD 平台。
- 直接从 devtools使用 APIC 捕获来自真实用户会话的 API ,或将您的网络请求导出为HAR 文件并导入到您的测试套件中。
API 文档
API 设计完成后,APIC 会自动将您的 API 设计转换为美观实用的文档,帮助其他人更快地上手。您甚至可以使用 APIC在线发布,与全世界分享。
还有更多令人兴奋的功能
另外值得一提的功能包括
- 免费团队和共享功能
- 实时更新团队成员对 API 项目/测试所做的更改。
- 导入/导出您在 APIC 中创建的所有内容。
- 无需安装任何东西。可作为网页应用使用。此外,还提供 Chrome 扩展程序、Windows exe 和 Mac dmg 文件。
最棒的是,它是免费且开源的。为了兑现“这是您所有 API 需求的唯一工具”这一说法,我已将 apic 开源,并希望引起社区的关注,并开始做出贡献。
听起来很有趣?快来我们的Github 页面贡献代码吧!当前版本是基于 angular-js 开发的,但 Angular 版本正在开发中。
希望你会喜欢我目前所做的一切。我很乐意在这里听到你的反馈。
文章来源:https://dev.to/bjdash/the-new-opensource-tool-for-all-your-api-needs-apic-1488