开发非英语 API 的最佳实践

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

我尝试过一款名为 Apidog 的工具,从 API 设计、API 开发和调试、API mocking 和 API 文档的角度来看,它代表了开发非英语 API 的最佳实践。

API 设计

Swagger 是 API 设计的标准工具。但是,如果 API 是面向非英语用户,那么 Swagger 的读写会非常困难。掌握 Swagger 本身就是一项重大挑战。

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

Apidog 为非英语语言的 API 设计提供了绝佳的替代方案。

  • 首先,Apidog 中的 API 设计是完全可视化的,用户无需掌握 Swagger 中复杂的 API schema 语法,即可通过可视化的方式设计符合规范的 API,并可轻松实现 schema 的可视化引用,以及使用组件的方式,提升 API 设计的效率和规范性。
  • Image description
  • 其次,Apidog 贴心地为非英语开发者提供了“title”属性,该属性以您的母语描述属性名称,与英文“name”属性相对应。(目前支持日语和葡萄牙语)
  • Image description
  • 除了可视化设计之外,Apidog 在创建响应示例时还会自动生成当前语言的模拟响应。(支持所有语言)
  • Image description

    API 文档

    当您以非英语语言创建 API 规范时,您可以在 Apidog 中发布多语言 API 文档。(支持所有语言)

    Image description

    API 开发和调试

    无论您的 API 规范使用哪种语言定义,Apidog 都允许您通过生成请求正文以所需的任何语言发送请求。(支持所有语言)

    Image description

    API 模拟

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

    Image description

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