产品

API设计

APIGit 使用广泛接受和支持的 OpenAPI 规范 3.0.x 作为定义行业 REST API 的标准。我们自主开发的、易于使用的、完全可视化的 OpenAPI 编辑器允许您快速、轻松地编写 API 规范,而无需任何 OpenAPI 规范的先验知识。可视化界面使任何人都可以轻松理解和创建 API 文档,简化开发过程并使您能够专注于创建符合行业标准的高质量 API。

API 规范查看模式 - 默认
在查看模式下,您可以通过视觉上令人愉悦的设计主题来查看 API 文档。此外,您还可以根据自己的喜好选择切换到原始的 swagger 主题。 API 规范在发布时将完全相同。通过点击“编辑”按钮,您可以进入 API 编辑模式。
API Spec 查看方式——swagger-ui view
在swagger视图模式下,您可以在swagger主题中查看API规范,让您轻松理解和交互标准格式的API文档。
API Spec 查看方式——代码查看
在代码模式下,显示原始、纯 API 规范内容,提供底层代码的直接视图。
API 规范查看模式 - 差异视图
在差异视图模式下,您可以将一个 API 规范与另一个 API 规范进行比较,并轻松识别它们之间的差异。

API规范编辑模式-表单视图
通过单击“编辑”按钮,API 规范进入表单编辑模式,使其成为修改 API 的最简单方法。这种模式不需要任何 OpenAPI 知识,因为规范完全可视化,易于理解和编辑。
API规范编辑模式-代码视图
在代码模式下,您可以查看原始 API 文档内容,方便您直接编辑或排查规范中的任何问题。
API规范编辑模式-差异视图
在diff 模式下,您可以将正在编辑的API 规范的当前版本与其原始版本进行比较,并直接对内容进行编辑。这使您可以轻松识别和解决两个版本之间的任何差异,确保更改准确并与原始版本保持一致。

创建或上传 API 规范
我们的平台提供了创建空 API 规范或将现有 API 规范上传到存储库的能力。此外,我们支持上传 HAR 文件的选项,该文件会自动将其转换为 API 规范。