API 资料库

APIGit

2023-04-22

Git-Feature-Update-V1-_2x.jpg

原生 git 的 API Reposiotry

API 已成为现代软件和业务基础架构不可或缺的一部分,提供了一种扩展软件功能并实现与外部服务高效集成的方法。因此,越来越多的各行各业的组织都在投资 API 开发,以增强内部和外部工作流程。

API 开发过程涉及多个阶段和利益相关者,使用不同的工具和流程。了解 API 生产者和消费者生命周期的各个阶段对于 API 的成功开发和管理至关重要。这些阶段通常包括规划、设计、开发、测试、部署和维护 API。

API 生产者负责创建和管理 API,而 API 消费者则利用 API 构建应用程序或与现有软件集成。这两个生命周期在不同阶段交叉,例如在测试阶段,API 生产者确保 API 满足 API 消费者的要求。

Apigit API 平台旨在帮助组织更有效地完成 API 开发和管理流程。使用 Apigit,原生 Git 支持是一项关键功能,允许用户将他们的 API 作为代码进行管理,并与其他团队成员无缝协作。

通过利用 Apigit 的功能,组织可以简化他们的 API 开发和管理流程,减少构建和部署高质量 API 所需的时间和精力。这最终会提高运营效率并更好地与外部服务集成,使企业能够在现代数字环境中保持竞争力。

什么是 API 存储库?

Apigit的API Repository,是navtive Git Repository,是你创建API和管理API整个生命周期的地方。 API 存储库保存和维护 API 文档、测试和规范以及代码。这允许 Apigit 客户改善与 API 生产者的协作,因为您可以在多用户、多分支设置中与您的团队合作。在您准备好发布之前,您可以在不影响您的团队或消费者的情况下提交和推送更改。

API development lifecycle API开发生命周期

如何使用 API 存储库来管理您的 API

第 1 步:创建存储库

Apigit 的 API 抽象是所有 API 工作流的核心。首先,创建一个存储库并添加 API 规范。

随着越来越多的开发团队构建 API 而不是共享库,源代码协作通常与其他 API 工作流(Apigit 集合、定义、合同测试和文档)脱节。这会导致次优的生产力; API 在整个组织中重复,合同并不总是得到遵守。我们相信存储库是更广泛的 API 构造的一个组成部分,因为它包含 API 的源代码。

第 2 步:设计、开发并与您的队友协作

现在 API Repository 已经设置好了,您可以开始设计和开发它了。在 Apigit 中添加定义和集合,模拟和测试 API。

对于 Git 链接的 API,您总是在一个分支上工作。当前分支显示在 API 上(检查右上角),源代码管理面板在右侧。您可以像在本机 git 中一样提交和推送更改到您的存储库。在任何时候,您还可以查看提交历史,将您的更改与上次提交进行比较,甚至放弃更改。所有这一切现在都可以在 Apigit 中实现,使您能够根据您的团队采用的 Git 工作流程有效地工作。

API 开发的一个重要部分是与您的队友协作。您的队友现在可以提取您所做的更改并开始协作。如果同时对同一文件进行更改,Apigit 允许您解决冲突。

所做的更改仅对 API 的编辑者可见——他们可以切换到分支并查看对存储库所做的所有更改。

第 3 步:测试和自动化 API

您可以从向 API 存储库添加测试开始。这些可以通过模拟复杂的 API 使用场景来验证您的 API 的功能。

API 开发完成后,即可将其部署到您的运行时环境中。

第 4 步:发布您的 API 并将其分发给消费者

作为一个跨多个分支处理复杂 API 的团队,您的利益相关者(无论是团队内部还是外部)都需要一个可参考的 API、完整的文档和一个沙箱以启用评估端点。

您现在可以拥有 API 的版本,就像 API 的锁定状态一样,您可以将其发送给消费者。版本发布后,消费者将继续看到该版本,直到您发布新版本。消费者还可以返回到之前发布的任何版本。这有助于您将任何开发中的更改与您的 API 使用者隔离开来,并且他们只会看到您希望他们使用的 API 的稳定/已发布版本。

版本还可以帮助您随时间记录 API 的变更日志,这可用于指示您的 API 在多个版本中的发展情况。

第 5 步:收集反馈并迭代您的 API

API 发布后,您将获得一些反馈,并可能希望开始添加新的端点或修复一些问题。您可能会从您的集合中发送一些请求,以了解当前的 API 行为并编辑您的 API 定义或集合。

您的下一步将是进行更新并将更改推送到您的存储库。您可以首先在 Apigit 中创建一个新分支并对 API 进行更改。

在任何时候,您都可以放弃您在 Apigit 存储库中所做的更改,或者查看您所做的更改与存储库的最后状态之间的差异,最后将更改推送到存储库。