OpenAPI Generator 工具的躺坑尝试

本文介绍了如何利用OpenAPIGenerator进行API定义和代码生成,以提高开发效率。作者分享了从SwaggerHub导出YAML文件,通过Gradle插件管理SpringBoot项目,以及在独立模块中组织生成代码的步骤。尽管工具存在冗余和理解难度,但建议仅用于生成Models和API接口,以简化代码并提升灵活性。项目源码和参考资料链接已提供。
部署运行你感兴趣的模型镜像

讲道理,这个工具覆盖的语言比较全,But 不是很好用的工具,里面包含的坑还是很多。从GitHub上的就可以看出,Star 7.8k,而issuer就已经提了2k个,慎用……

如果你希望使用的Swagger 2.0 版本的 OpenAPI的 V2版本,那么使用Swagger-Codegen是可以很好的满足自己的需求的;

OpenAPI Generator 是从Swagger-codegen中专门切分出来,用来满足快速开发的OpenAPI V3的版本。

Overview

这个项目的代码,是我基于这两天的学习整理出来的,主要是想通过 Swagger UI的界面,采用最新的 OpenAPi V3 的语法风格来生成相关的 yaml 文件,通过该yaml文件能够借助 OpenAPI Generator 的相关工具来自动的生成代码。

使用这个插件开发的相关思路说明:(帮助你提前避坑)

  1. 通过SwaggerHub 的Web界面,来定义好相关的API,编写好之后导出成yml格式文件;
  2. 引入OpenAPI 的Gradle插件来管理SpringBoot的项目;
  3. 尽量单独的起一个子模块来完全的存储OpenAPI Generator 产生的所有代码
  4. 实际的业务逻辑代码,可以在其它独立的模块中编写,并引入OpenAPI Generator生成的模块。

在使用这个工具的实际过程中,随着编写的加深,会感觉到自动生成的代码,非常的冗余且不好理解。这里个人建议,**只使用 OpenAPI Generator 工具生成最简单的模块(Models)和APi的接口。**好处不言而喻,在减少重复编写的代码的同时,能够极大的提升代码的灵活性。

项目地址

https://gitee.com/ilovestudy1314/spring-boot-guide 中的 swagger-codegen 分支

资料参考


  1. 官方的Github项目地址。 OpenAPI Generator
  2. OpenAPI接口的规范定义文档 OpenAPI-Spec
  3. OpenAPI同SpringBoot继承的项目是 springfox
  4. 生成器中,专门对于Spring环境下的配置说明 Generators - Spring - ConfigurationOption

您可能感兴趣的与本文相关的镜像

Seed-Coder-8B-Base

Seed-Coder-8B-Base

文本生成
Seed-Coder

Seed-Coder是一个功能强大、透明、参数高效的 8B 级开源代码模型系列,包括基础变体、指导变体和推理变体,由字节团队开源

openapi-generator-cli 是一个用于根据 OpenAPI 规范文件生成不同编程语言代码的工具。`openapi-generator-cli generate -i petstore.yaml -g ruby` 这一命令,旨在依据 `petstore.yaml` 这个 OpenAPI 规范文件来生成 Ruby 代码。 ### 使用说明 - **命令格式**:`openapi-generator-cli generate -i <input-spec> -g <generator-name>`。其中,`-i` 用于指定输入的 OpenAPI 规范文件路径,像 `petstore.yaml` 就可作为输入文件;`-g` 用于指定要生成代码的目标编程语言,这里的 `ruby` 就代表生成 Ruby 代码。 - **执行步骤**:首先要确保系统里已经安装了 `openapi-generator-cli`。接着,在命令行里运行该命令,命令执行之后,会依据 `petstore.yaml` 文件的内容生成对应的 Ruby 代码,生成的代码会存于当前工作目录下的默认输出目录中。 ### 常见问题及解决办法 - **输入文件不存在**:若提示 `petstore.yaml` 文件不存在,需检查文件路径是否正确,以及文件是否真的存在于指定位置。 - **生成器不支持**:要是出现 `ruby` 生成器不被支持的提示,要确认 `openapi-generator-cli` 版本是否支持 Ruby 代码生成,可尝试更新到最新版本。 - **依赖问题**:生成代码时可能会因为缺少 Ruby 相关依赖而失败,此时需要检查并安装所需的 Ruby 依赖库。 - **规范文件错误**:若 `petstore.yaml` 文件存在格式错误或不符合 OpenAPI 规范,代码生成也会失败,需要使用工具对 `petstore.yaml` 文件进行验证和修复。 ### 示例代码 ```bash # 运行代码生成命令 openapi-generator-cli generate -i petstore.yaml -g ruby # 若要指定输出目录,可使用 -o 参数 openapi-generator-cli generate -i petstore.yaml -g ruby -o output_directory ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值