API 定义是前端和后端团队、API 消费者和生产者(无论公司内部还是外部)之间的沟通枢纽。它们是您的 API 战略的核心要素。但编写好的 API 定义可能具有挑战性,因为您需要了解底层规范的所有细节。
Restlet 提供了 Restlet Studio,这是一个用于 OpenAPI 规范(简称 OAS,前身为 Swagger 规范)的可视化编辑器,旨在简化 API 契约的编写,并帮助您快速启动客户端 SDK 和服务器骨架代码生成,或将其他 API 格式转换为 OAS。
Restlet 是 Open API Initiative 的创始成员 — 该组织在 Linux 基金会的支持下,负责 OAS 的标准化和演进。
可视化编辑
Restlet Studio 提供了一种更具可视化和交互性的体验,而非在文本编辑器或 IDE 中手动编写 Swagger JSON 或 YAML 定义。使用鼠标或键盘快捷键浏览丰富的组件,编辑您的端点、部分、资源、方法、数据类型等!无需了解 OAS 语法的全部细节,只需在 UI 中导航即可!
代码生成
如果您是契约优先的拥护者,您将能够设计您的 API,并快速启动后端代码(使用服务器骨架实现您的 API)以及供消费者调用您的 API 的客户端 SDK。因此,您将找到适用于 Java、Android、iOS、Node.JS、Angular.JS 等的工具包。
API 定义转换
您可能已经拥有现有的 OAS 定义,因此可以轻松将其导入 Restlet Studio。但它也支持其他 API 格式,并允许您将 OAS 定义导出为其他格式。通过 Studio,您实际上拥有了一个 API 定义转换器,当您需要在不同世界之间进行桥接,或希望从一种格式转换为另一种格式时,它将派上用场。
以下截屏视频提供了 Restlet Studio 及其各项功能的精彩概述。当然,您也可以阅读我们的在线文档。
准备好开始您的 Swagger 规范可视化体验了吗?
