APIGit
2023-04-27
在 Apigit,我们努力使 API 民主化,并使用户能够通过 Apigit API 平台使用和构建 API,以实现一个繁荣的 API 优先世界。我们拥有数以万计的用户,不断扩大我们的影响范围,并提供访问 Apigit 必须提供的最佳机会的途径——从新手到高级用户。
要访问下面列出的任何特定功能,您必须首先创建一个 Apigit 帐户并登录。可以直接从您首选的浏览器访问 Apigit。
登录后,您可以探索这五个令人兴奋的功能以开始使用 Apigit。
创建 Apigit 帐户后,您可以探索该平台的各种功能,包括创建存储库。存储库是您可以存储代码并与他人协作的空间。
要创建存储库,请导航到 Apigit 仪表板的顶部,然后单击+
符号。从下拉菜单中选择New repository
.在下一页上,系统将提示您输入存储库的名称和可选描述。提供此信息后,单击“创建存储库”按钮以完成该过程。
恭喜,您已经在 Apigit 上成功创建了您的第一个存储库!您现在可以开始添加文件、与他人协作以及利用该平台的许多其他功能。
第一步:创建存储库
要将 API 规范添加到您的 Apigit 仪表板,请单击+
标志位于左上角。输入路径名,例如test/myfirst.json
,以及其他相关信息,例如title
和version
.
在添加新的 API 规范之前,您可能想要浏览存储库中提供的示例。通过单击左侧边栏中的 🪄 图标,您可以切换到不同的查看器。例如,您可以选择petstore-json-format.json
文件来自examples
文件夹并将查看器切换到code
查看示例规范的 JSON 格式代码。
要编辑您的 API 规范,请将鼠标悬停在文件上并单击⋮
文件末尾的图标或单击仪表板左下角的✏️图标。然后您可以从示例中复制 JSON 代码并使用它来创建您自己的规范。这是您的第一个 API 规范的示例。
第二步:添加 api spec
模拟服务器通常用于 API 开发,以在 API 完全实现之前模拟 API 的行为。开发人员可以使用模拟服务器来测试他们的代码并确保它按预期工作,而无需等待 API 完成或必须向真实服务器发出请求。
在 Apigit 中部署模拟服务器是一个简单的过程。首先,导航到您的存储库并单击Mock Server Script
按钮。完成服务器脚本后,发布服务器。然后,您可以在Mock Servers
位于顶部菜单中的页面。
第三步:创建并发布模拟服务器
API 测试是验证 API 是否符合其规范,是否可以处理不同类型的输入和输出,以及是否优雅地处理错误和异常的过程。 API 测试可以手动进行,也可以使用模拟对 API 的请求和响应的自动化工具进行。
要在 Apigit 上开始 API 测试,请单击Test Cases
位于存储库下方的按钮。在这里,您将找到 API 测试示例。创建自己的测试用例并替换baseurl
使用在步骤 3 中生成的模拟服务器 URL。
发布 API 测试用例后,您可以在API Testing
页。您可以通过单击API Testing
顶部菜单中的按钮。
第四步:创建并发布API Testing
Apigit 是一个流行的 API 协作平台,可以轻松共享工作。无论您是与一个朋友一起从事小型项目,还是拥有数百名开发人员积极致力于公共 API 的企业公司的一部分,您都可以控制可见的内容以及对谁可见。
如果您创建了您认为世界应该看到的东西,您可以将其发布到 Apigit API 网络。这将允许全球的 Apigit 用户访问您的收藏。
现在您已经掌握了一些基础知识,请花一些时间在 Apigit 上探索和发现更多有用的功能。例如,您是否知道可以设计一个依赖于另一个 API 结果的 API 测试用例?探索此工具以及平台上提供的许多其他有用工具。