开发非英语 API 的最佳实践

发布时间： 2024年12月30日

OpenAPI（Swagger）是最流行的API设计工具，而Postman是最广泛使用的API开发和调试工具。但是，如果您团队的工作语言不是英语，那么 Swagger 和 Postman 可能不是最佳选择。

我尝试过一个叫做 Apidog 的工具，从 API 设计、API 开发和调试、API 模拟和 API 文档的角度来看，它代表了开发非英语 API 的最佳实践。

API设计

Swagger 是 API 设计的标准工具。但是，如果 API 旨在用于非英语用途，则 Swagger 的读写可能会非常困难。掌握 Swagger 本身就是一项重大挑战。

这常常导致许多非英语母语团队放弃定义 API 规范，而是选择编写代码来实现功能。因此，开发的 API 可能会变得难以调用和协作。

Apidog 为用非英语语言设计 API 提供了一个很好的选择。

• 首先，Apidog 中的 API 设计完全是可视化的。您无需掌握 Swagger 中复杂的 API 架构语法；您可以直观地设计兼容的 API。您可以轻松直观地引用架构，并使用组件来提高 API 设计的效率和标准化。

• 其次，Apidog贴心地为非英语开发者提供了“title”属性，用您的母语描述房产的名称，与英文的“name”属性相对应。 （目前支持日语和葡萄牙语）

• 除了可视化设计之外，Apidog 在创建响应示例时会自动生成当前语言的模拟响应。 （支持所有语言）

API文档

当您使用非英语创建 API 规范时，您可以在 Apidog 中发布多语言 API 文档。 （支持所有语言）

API开发与调试

无论您的 API 规范是用什么语言定义的，Apidog 都允许您通过生成请求正文以您需要的任何语言发送请求。 （支持所有语言）

API模拟

您还可以根据您的规范生成相应的 Mock API。 （支持所有语言）

总体而言，Apidog 为非英语开发人员提供了全面的解决方案，在设计、记录、开发和测试 API 方面提供无缝体验。该工具使开发人员能够专注于构建功能，而不受语言障碍的阻碍，有效地弥合了软件开发中不同语言之间的差距。