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 平台构建,其基因中就带有对多文件项目的支持。基于 JSON Reference 标准的 OpenAPI $ref 属性提供了基本机制。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 实现会有所不同呢?

如果您正在使用代码优先(code-first)注解,那么您正在实践代码即契约(code-as-contract)。对于许多开发人员来说,这是保持 API 文档和实现同步的理想方式。但在许多情况下,API 优先(API-first)或契约优先(contract-first)的工作流具有明显的优势。

RepreZen API Studio 将 API 设计和代码生成直接带入开发环境,实现了真正的契约即代码(contract-as-code)

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

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

https://youtu.be/BltFUgXRhhI

现已在 Eclipse Marketplace 上架

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

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

    在此注册即可开始。

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

    Eclipse Marketplace

Drag to your running Eclipse workspace.

让我们构建一些 API!

试用 RepreZen API Studio 免费版,在 API 优先开发中发挥您的最佳水平。

Try RepreZen API Studio Free!

© . All rights reserved.