OpenAPI自动生成代码

原创 已于 2023-08-29 09:41:14 修改 · 5k 阅读 · 18 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #后端 #java

于 2020-04-25 19:08:59 首次发布
本文介绍前后端分离架构下，如何使用Swagger和OpenAPI规范进行接口设计与文档生成，涵盖YAML配置、Maven插件设置及多接口文件处理技巧。

前后分离后接口实现先定义采用yaml的方式。

核心关键字：OpenAPI、swagger

教程：https://www.cnblogs.com/meihuashou/articles/16471654.html

swagger yaml 规范3.0

Basic Structure

swagger yaml 规范2.0

Basic Structure

swagger-api

GitHub - swagger-api/swagger-codegen: swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.

生成代码基于swagger2.0的代码官方例子

https://github.com/OpenAPITools/openapi-generator/tree/master/samples/server/petstore/springboot/src/main

一个能运行的例子

GitHub - thomasJoei/swagger-codegen-springboot: Ready to use example of Swagger codegen, using swagger-codegen-maven-plugin.

swagger-codegen-maven-pluging官方

https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen-maven-plugin

需要设置swagger生成的代码的文件夹为source

Swagger Documentation

java - Remove ResponseEntity in swagger-codegen-maven-plugin api class - Stack Overflow 

swagger codegen 和OpenAPI codegen的区别

https://openapi-generator.tech/docs/faq/#what-is-the-difference-between-swagger-codegen-and-openapi-generator

多个接口文件可以参考Use Groovy to customize the Maven build process | Red Hat Developer

json - Generate code for multiple swaggers in the same project - Stack Overflow

数据类型：Data Types

多个接口文件的核心：

1、先保证单个的可以正常编译（A和B）

2、复制A接口yml文件及相关定义的yml文件到同B项目对应目录

3、修改B项目的pom.xml

3.1）复制一份（是一对）execution，然后对原来的execution增加id标签（如没有id标签的话增加）并将id的值命名为g01，原来B项目的execution的id标签的id值命名为g02

4、编译即可 

 

韩明君
关注
React--》掌握openapi-typescript-codegen快速生成API客户端代码
ztK63LrD的博客
11-14 2264
今天深入探索一个神奇的工具——。它不仅能够帮助你快速生成TS代码，还能让你的API请求更加高效、类型安全，让开发者摆脱手动编写冗长请求代码的困扰，专注于实现业务逻辑。接下来让我们一起来了解它的强大功能和使用技巧，提升你的开发体验！
使用 OpenAPI Typescript Codegen 一键生成前端接口代码
trinityleo5的博客
09-25 3573
使用 OpenAPI Typescript Codegen 一键生成前端接口代码
open api文档自动生成工具
02-06
自己开发的，可以通过在线编辑JSON数据自动生成HTML API说明文档，分享一下！
openapi-generator,openapi生成器允许自动生成api客户端库（sdk生成）、服务器存根、文档和配置，并给出openapi规范（v2，v3）.zip
09-25
openapi生成器
Swagger Codegen（代码生成）
最新发布
m0_57545130的博客
11-21 630
摘要： 《Swagger Codegen / OpenAPI Generator 终极实战手册（2025最新版）》全面升级为OpenAPI Generator（OAG），提供核心命令、10大常用生成器及大厂级配置模板。涵盖TypeScript、Spring Boot等主流技术栈，并附赠一键生成脚本与多语言SDK模板包（含拦截器、错误处理等企业级功能）。通过3行命令即可快速生成前后端代码，显著提升开发效率。回复关键词可获取200MB完整模板包，实现API-SDK自动化生成，适合面试与项目实战场景。
openapi-generator-typescript
05-21
openapi-generator-typescript 入门 使用yarn安装openapi-generator-typescript： yarn add --dev @yuanfudao/openapi-generator-typescript 然后，创建配置文件 。 是带有JavaScript样式注释的JSON。 Microsoft在所有VSCode配置文件和tsconfig.json中使用它。 我们仅支持OpenAPI规范版本3（也称为swagger v3） 当前的实现并不完美，我们仅对进行了改编 运行yarn openapi-generator-typescript --update ，将创建'api-docs / * yarn openapi-generator-typescript --update | yaml'。 您还可以在npm-scripts中使用node
强大的openAPI代码生成器——OpenAPI Generator
m0_63615227的博客
11-16 4837
OpenAPI Generator是一个开源的项目，它可以根据OpenAPI规范（以前称为Swagger规范）生成API客户端库、服务器存根和文档。OpenAPI规范是一种描述RESTful API的标准方式，它使用JSON或YAML格式定义API的结构、终端点、参数、响应等信息。
使用openapi直接生成service代码
weixin_66383346的博客
06-12 1335
这是指定输入文件的参数。这里输入的不是一个本地文件，而是一个 URL。该 URL 指向一个 OpenAPI 规范文档，这个文档描述了 API 的端点、请求和响应格式等。具体来说，它们从 OpenAPI 规范文件（API 描述文件）生成 TypeScript 客户端代码库。:这是指定输出目录的参数。生成的 TypeScript 客户端代码将被放在当前目录下的。，这是一种基于 Promise 的 HTTP 客户端，用于浏览器和 Node.js。:这是指定生成代码使用的 HTTP 客户端库的参数。
精选资源
swagger-axios-ts-generator:通过swagger openapi自动生成axios-ts代码
04-07
@ toft-code / swagger-axios-ts-generator 安装 $ npm install @toft-code/swagger-axios-ts-generator $ yarn add @toft-code/swagger-axios-ts-generator 例子 打字稿 import { generate } from '@toft-code/...
精选资源
openapi3-generator:使用您的API OpenAPI 3定义生成代码，文档以及几乎所有您需要的内容
05-17
使用您的API OpenAPI 3定义生成代码，文档以及几乎所有您需要的内容。 安装 要从CLI使用它： npm install -g openapi3-generator 要求 Node.js v7.6 + 用法 从命令行界面（CLI） Usage: og [options] ...
openapi：Nim的OpenAPI代码生成器
02-03
在Nim中，`openapi`项目提供了一个工具，可以根据OpenAPI规格自动生成Nim客户端代码，从而简化与API交互的过程。 **Nim OpenAPI代码生成器的主要功能：** 1. **自动代码生成**：这个工具可以从OpenAPI规格文件...
openapi:根据SwaggerOpenAPI规范生成JavaScript或TypeScript代码
05-07
openapijs / openapi 根据Swagger / OpenAPI规范生成JavaScript或TypeScript代码。 安装 npm install openapi # or yarn add openapi # or to global space 例子 yarn openapi --file ../src/mocks/local-file-api.json # or yarn openapi --file ../src/mocks/local-file-api.yaml # or yarn openapi --file protocol://url/api.json 使用CLI yarn openapi [options] Options: -V, --version output the version number --output
openapi-typescript-code-generator:通过OpenAPI方案的TypeScript代码生成器
04-04
@ himenon / openapi-typescript-code-generator 该软件包根据OpenAPI v3系列API规范生成TypeScript typedef和API客户端。 它使用TypeScript AST生成代码，并将其完全转换为TypeScript代码。 它不仅将allOf和oneOf转换为intersection类型和并union类型，还将参考目标的目录结构转换为namespace并生成API客户端。 目录的层次结构将转换为类型定义的层次结构。 用法 安装 yarn add -D @himenon/openapi-typescript-code-generator 演示 基本用法 import * as fs from "fs" ; import * as CodeGenerator from "@himenon/openapi-typescript-code
openapi-typescript-codegen：一键生成前端请求代码
wmh的博客
04-20 1661
openapi-typescript-codegen 是一个用于生成 TypeScript 代码的工具，它可以根据 OpenAPI 规范（以前称为 Swagger）自动生成客户端和服务器端代码。这个工具可以帮助开发人员快速地创建符合 API 规范的 TypeScript 代码，减少手动编写重复代码的工作量。通过使用 openapi-typescript-codegen，开发人员可以更容易地与 API 进行交互，并确保代码的一致性和准确性。
百家饭OpenAPI v0.6.0新版夏日发布！快来看（4）——API代码自动生成
baijiafan的博客
08-25 797
百家饭OpenAPI工具更新到了v0.6.0版本，带来了全新的API工作台和配套的客户端工具，测试完不过瘾？今天干脆把API调用代码也自动生成啦
探索SwagGen：高效OpenAPI代码生成器
gitblog_00365的博客
08-18 420
探索SwagGen：高效OpenAPI代码生成器 项目介绍 SwagGen是一款专为OpenAPI/Swagger 3.0规范设计的代码生成工具，完全采用Swift语言编写。它不仅提供了一个强大的Swagger解析库，还包含一个命令行工具，能够根据OpenAPI规范生成各种语言的代码模板。尽管项目目前不再活跃开发，但其稳定性和功能性使其成为开发者的优选工具。 项目技术分析 SwagGen的核心优势...
OpenAPI-Generator——为开发者提供全能编程体验
云满笔记
09-19 3086
OpenAPI-Generator——为开发者提供全能编程体验
【亲测免费】 探索OpenAPI Generator：强大的API代码生成工具
gitblog_00094的博客
03-19 2001
探索OpenAPI Generator：强大的API代码生成工具 【免费下载链接】openapi-generator OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentat...
openapi-typescript-code-generator：自动生成 TypeScript 代码的强大工具
gitblog_00016的博客
03-30 661
openapi-typescript-code-generator：自动生成 TypeScript 代码的强大工具 在当今的软件开发中，API 的定义和实现是构建应用程序的核心部分。OpenAPI 规范已成为描述 RESTful API 的主流标准，而 TypeScript 作为 JavaScript 的超集，以其类型安全特性在开发者中备受青睐。今天，我们将为您介绍一个开源项目——openapi-...
openapi 自动生成sdk
10-12
OpenAPI 自动生成 SDK 是一种自动化工具，用于根据 OpenAPI 规范自动生成软件开发包（SDK）的代码。OpenAPI 是一种用于描述和定义 RESTful API 的规范，它提供了一种标准化的方式来描述 API 的终点、参数、请求和响应等信息。 使用 OpenAPI 自动生成 SDK 可以极大地简化开发人员在使用 API 时的工作。传统上，开发人员需要手动编写与 API 直接交互的代码，包括构造请求、处理响应、处理错误处理等。这样的工作繁琐且容易出错，而且可能需要花费大量的时间和精力。 而有了 OpenAPI 自动生成 SDK，开发人员只需提供 API 的 OpenAPI 规范文件，然后通过工具自动生成与 API 交互所需的代码。生成的 SDK 包含了 API 的各种调用方法，以及参数校验、请求构建、响应解析等功能。开发人员只需简单地调用生成的方法，就能快速地完成与 API 的交互，并且可以直接使用生成的代码进行开发。 OpenAPI 自动生成 SDK 并不仅限于特定的编程语言或框架，它可以生成适用于多种编程语言的代码。这样，开发人员可以根据自己的需求选择合适的编程语言进行开发，而不需要对于 API 的交互细节有过多的了解。 总而言之，OpenAPI 自动生成 SDK 是一种能够根据 API 的 OpenAPI 规范自动生成与 API 交互所需代码的工具。它可以极大地简化开发人员的工作，提高开发效率，并且能够适用于多种编程语言。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值