RepreZen API Studio 1.5 将 Swagger 带入您的 IDE

  2017 年 2 月 23 日

RepreZen API Studio 是一个真正的 API 开发 IDE,它拥有您需要的一切,可以进行设计、文档和开发,从而提供端到端的 API 解决方案。 一些关键功能包括:

  • 功能齐全的 Swagger-OpenAPI 编辑器,具有内容辅助、可自定义的代码模板、实时验证、多文件支持等。
  • 实时图表、文档和 Swagger-UI视图,带有用于交互式沙盒测试的内置模拟服务。
  • 自定义代码生成,具有强大的模板驱动框架,并完全支持 Swagger-Codegen。
  • 通过 Git、Github 和其他版本控制、问题跟踪和 ALM 工具进行插件式团队协作。

RepreZen 使您可以使用 OpenAPI 描述语言和 Swagger 库作为开发过程中的一流工具。 在 1.5 版本中,RepreZen 通过强大的多文件支持、拖放式 Eclipse 安装、改进和扩展的代码生成进一步增强了这一点。

多文件,一路到底

API 会变得很大。 API 程序可能会变得更大,包括跨职能团队、不断发展的微服务架构,以及在各个 API 中标准化和重用定义的推动。

在这样的环境中,尝试在单个文件中管理您的 API 规范确实会受到限制,并且最终不切实际。 因此,如果您的 API 规范开始感觉像一个整体,RepreZen 可以让您进行分而治之。

API Studio 基于开源 Eclipse 平台构建,其 DNA 中包含多文件项目。 OpenAPI $ref 属性 基于 JSON Reference 标准,提供了基本机制。 API Studio 将其集成到 API 设计体验的各个方面:内容辅助、超链接和快速大纲导航、代码生成以及我们改进的文档视图。 这些都支持多文件,并为您的最大、最复杂的项目做好准备。

https://www.youtube.com/watch?v=xKhNAQuq1x0&feature=youtu.be

使用 Swagger Normalizer 合并和简化

并非每个 Swagger 代码生成器或文档查看器都能正确处理 $ref 属性。 实际上,OpenAPI 有许多规则,这些下游组件必须遵守这些规则才能正确解释 Swagger 规范。

Swagger Normalizer 通过解析引用、使默认值显式以及直接在使用的位置嵌入继承的属性来解决此问题。 RepreZen API Studio 自动将 Swagger Normalizer 作为实时视图和代码生成的预处理器; 您可以将其用作独立的生成器,将复杂的多文件项目合并和简化为单个 JSON 或 YAML Swagger 规范。

合同就是代码。

API 规范具有强大的表达能力来描述您的 API,不仅是对其他开发人员,而且是对客户端应用程序、服务、网关和整个生态系统中的其他组件。

那么为什么您自己的 API 实现应该有所不同呢?

如果您使用代码优先的注释,则您正在实践代码即合同。 对于许多开发人员来说,这是保持 API 文档和实现同步的理想方式。 但是,在许多情况下,API 优先或合同优先的工作流程具有明显的优势。

RepreZen API Studio 将 API 设计和代码生成直接引入开发环境,从而实现真正的合同即代码。

API Studio 完全支持 Swagger-Codegen,并具有简单的 YAML 配置,现在还包括流行的 NSwag 工具链,适用于 .NET、Web API 和 TypeScript。 您甚至可以使用 RepreZen 强大的 代码生成框架构建自己的生成器。

所有生成器都可以在 IDE、命令行或您的自动化 CI/CD 构建中使用 Maven 或 Gradle 运行。

https://youtu.be/BltFUgXRhhI

现在可在 Eclipse Marketplace 上获得

对于 Eclipse 用户来说是个好消息! 现在有两种方法可以使用 RepreZen API Studio

  • 在 Windows、MacOS 或 Linux 上安装为独立的 API 工作台。

    在此处注册以开始使用。

  • 从以下位置拖放安装到您的 Eclipse IDE (Mars.2、Neon 或 Oxygen):

    Eclipse Marketplace

Drag to your running Eclipse workspace.

让我们构建一些 API!

查看 RepreZen API Studio 的免费试用版,并将您的 A 级游戏带入 API 优先开发。

Try RepreZen API Studio Free!