OpenAPI Generator 工具的躺坑尝试

2024-08-25 07:08

本文主要是介绍OpenAPI Generator 工具的躺坑尝试,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

讲道理,这个工具覆盖的语言比较全,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

这篇关于OpenAPI Generator 工具的躺坑尝试的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/1104885

相关文章

Python办公自动化实战之打造智能邮件发送工具

《Python办公自动化实战之打造智能邮件发送工具》在数字化办公场景中,邮件自动化是提升工作效率的关键技能,本文将演示如何使用Python的smtplib和email库构建一个支持图文混排,多附件,多... 目录前言一、基础配置:搭建邮件发送框架1.1 邮箱服务准备1.2 核心库导入1.3 基础发送函数二、

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

Linux中压缩、网络传输与系统监控工具的使用完整指南

《Linux中压缩、网络传输与系统监控工具的使用完整指南》在Linux系统管理中,压缩与传输工具是数据备份和远程协作的桥梁,而系统监控工具则是保障服务器稳定运行的眼睛,下面小编就来和大家详细介绍一下它... 目录引言一、压缩与解压:数据存储与传输的优化核心1. zip/unzip:通用压缩格式的便捷操作2.

sqlite3 命令行工具使用指南

《sqlite3命令行工具使用指南》本文系统介绍sqlite3CLI的启动、数据库操作、元数据查询、数据导入导出及输出格式化命令,涵盖文件管理、备份恢复、性能统计等实用功能,并说明命令分类、SQL语... 目录一、启动与退出二、数据库与文件操作三、元数据查询四、数据操作与导入导出五、查询输出格式化六、实用功

基于Python开发Windows屏幕控制工具

《基于Python开发Windows屏幕控制工具》在数字化办公时代,屏幕管理已成为提升工作效率和保护眼睛健康的重要环节,本文将分享一个基于Python和PySide6开发的Windows屏幕控制工具,... 目录概述功能亮点界面展示实现步骤详解1. 环境准备2. 亮度控制模块3. 息屏功能实现4. 息屏时间

SQLite3命令行工具最佳实践指南

《SQLite3命令行工具最佳实践指南》SQLite3是轻量级嵌入式数据库,无需服务器支持,具备ACID事务与跨平台特性,适用于小型项目和学习,sqlite3.exe作为命令行工具,支持SQL执行、数... 目录1. SQLite3简介和特点2. sqlite3.exe使用概述2.1 sqlite3.exe

基于Python实现一个Windows Tree命令工具

《基于Python实现一个WindowsTree命令工具》今天想要在Windows平台的CMD命令终端窗口中使用像Linux下的tree命令,打印一下目录结构层级树,然而还真有tree命令,但是发现... 目录引言实现代码使用说明可用选项示例用法功能特点添加到环境变量方法一:创建批处理文件并添加到PATH1

使用jenv工具管理多个JDK版本的方法步骤

《使用jenv工具管理多个JDK版本的方法步骤》jenv是一个开源的Java环境管理工具,旨在帮助开发者在同一台机器上轻松管理和切换多个Java版本,:本文主要介绍使用jenv工具管理多个JD... 目录一、jenv到底是干啥的?二、jenv的核心功能(一)管理多个Java版本(二)支持插件扩展(三)环境隔