【API 优先的设计】- 工具篇

所谓工欲善其事,必先利其器,在实现 API 优先的设计之前,首先需要准备好相关的工具。 与 OpenAPI 相关的工具非常多,强烈建议参考 OpenAPI.tools 网站,里面分类列出了常用的 OpenAPI 工具。

通常会使用的是下面 3 类工具:

第一类是 OpenAPI 文档的编辑器。由于 OpenAPI 文档规范比较复杂,直接以纯文本的方式编辑比较费劲。这里推荐的是图形化界面的编辑器 Stoplight Studio,使用简单而且功能强大。

第二类是 mock 服务器。mock 服务器主要由 OpenAPI 的消费者使用,包括前端开发和测试团队。使用了 mock 服务器之后,OpenAPI 的消费者不用等待后台实现,就可以进行开发和测试,提升了开发效率。 这里推荐的是 Prism,与 Stoplight Studio 来自同一家公司。

第三类是代码生成工具,主要由 OpenAPI 的提供者使用,可以快速生成代码的骨架,减少开发时间。 这里推荐的是 OpenAPI Generator,支持非常多的编程语言和框架,更新的速度也比较快。

除了这 3 类工具之外,还有一些与 OpenAPI 的解析、文档、安全和测试相关的工具,可以根据需要来使用。

版权所有 © 2024 灵动代码