OpenAPI自动生成代码

已于 2023-08-29 09:41:14 修改
阅读量4.8k 收藏 18
点赞数 26
文章标签： spring boot 后端 java
于 2020-04-25 19:08:59 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hanmingjun/article/details/105754826
版权

前后分离后接口实现先定义采用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、编译即可 

 

韩明君
关注
强大的openAPI代码生成器——OpenAPI Generator
m0_63615227的博客
11-16 2884
OpenAPI Generator是一个开源的项目，它可以根据OpenAPI规范（以前称为Swagger规范）生成API客户端库、服务器存根和文档。OpenAPI规范是一种描述RESTful API的标准方式，它使用JSON或YAML格式定义API的结构、终端点、参数、响应等信息。
Spring Boot 与OpenAPI：实现自动化API文档生成
阿里渣渣java研发组-群主
06-01 1074
OpenAPI是一种API描述格式，允许开发者定义其API的端点、请求和响应格式、认证方式等。OpenAPI规范可以自动生成API文档，简化了API的使用和维护。
open api文档自动生成工具
02-06
自己开发的，可以通过在线编辑JSON数据自动生成HTML API说明文档，分享一下！
Spring Boot与OpenAPI的集成
聚娃科技开发者博客
07-07 368
OpenAPI（以前称为Swagger）是一种用于设计、构建和文档化API的开放标准，它提供了强大的工具和库来简化API的开发和维护。本文详细介绍了如何在Spring Boot项目中集成OpenAPI（Swagger），包括项目初始化、Swagger配置和创建API接口。在Swagger UI中，您可以看到自动生成的API文档，包括每个接口的详细说明、请求参数、响应类型等信息。在上面的配置中，我们启用了Swagger，并指定了扫描的API包路径。首先，创建一个Spring Boot项目，并添加必要的依赖。
使用openapi直接生成service代码
weixin_66383346的博客
06-12 608
这是指定输入文件的参数。这里输入的不是一个本地文件，而是一个 URL。该 URL 指向一个 OpenAPI 规范文档，这个文档描述了 API 的端点、请求和响应格式等。具体来说，它们从 OpenAPI 规范文件（API 描述文件）生成 TypeScript 客户端代码库。:这是指定输出目录的参数。生成的 TypeScript 客户端代码将被放在当前目录下的。，这是一种基于 Promise 的 HTTP 客户端，用于浏览器和 Node.js。:这是指定生成代码使用的 HTTP 客户端库的参数。
openapi-typescript-codegen：一键生成前端请求代码
wmh的博客
04-20 805
openapi-typescript-codegen 是一个用于生成 TypeScript 代码的工具，它可以根据 OpenAPI 规范（以前称为 Swagger）自动生成客户端和服务器端代码。这个工具可以帮助开发人员快速地创建符合 API 规范的 TypeScript 代码，减少手动编写重复代码的工作量。通过使用 openapi-typescript-codegen，开发人员可以更容易地与 API 进行交互，并确保代码的一致性和准确性。
百家饭OpenAPI v0.6.0新版夏日发布！快来看（4）——API代码自动生成
baijiafan的博客
08-25 705
百家饭OpenAPI工具更新到了v0.6.0版本，带来了全新的API工作台和配套的客户端工具，测试完不过瘾？今天干脆把API调用代码也自动生成啦
openapi-generator,openapi生成器允许自动生成api客户端库（sdk生成）、服务器存根、文档和配置，并给出openapi规范（v2，v3）.zip
09-25
openapi生成器
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] ...
RefitGenerator:根据OpenApi定义生成Refit客户端代码的工具
03-04
RefitGenerator是一个全球性dotnet tool用来生成从OpenAPI的架构客户端代码。 用法 输入regen -h将显示参数列表： -u或--url -OpenApi json或yaml的URL -f或--file -OpenApi json或yaml本地文件的路径 -o或--...
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
api:from根据OpenAPI定义自动生成SDK
04-28
从OpenAPI定义自动生成SDK。 安装 npm install api --save 用法 使用api就像提供它的OpenAPI和使用SDK一样简单，就像您使用其他任何工具一样！ const sdk = require ( 'api' ) ( '...
探索SwagGen：高效OpenAPI代码生成器
最新发布
gitblog_00365的博客
08-18 349
探索SwagGen：高效OpenAPI代码生成器 SwagGenOpenAPI/Swagger 3.0 Parser and Swift code generator项目地址:https://gitcode.com/gh_mirrors/sw/SwagGen 项目介绍 SwagGen是一款专为OpenAPI/Swagger 3.0规范设计的代码生成工具，完全采用Swift语言编写。它不仅提供了一...
OpenAPI-Generator——为开发者提供全能编程体验
云满笔记
09-19 1985
OpenAPI-Generator——为开发者提供全能编程体验
探索OpenAPI Generator：强大的API代码生成工具
gitblog_00094的博客
03-19 1345
探索OpenAPI Generator：强大的API代码生成工具 openapi-generatorOpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an Op...
使用 OpenAPI Typescript Codegen 一键生成前端接口代码
trinityleo5的博客
09-25 2662
使用 OpenAPI Typescript Codegen 一键生成前端接口代码
通过OpenAPI和Visual Studio生成客户端代码
L.的博客
04-28 572
根据，我们得知，我们可以通过Visual Studio连接API，进而自动生成对应的客户端代码。首先，我们启动一个本地服务。代码可以参考。这里我们获得了一个API地址：http://localhost:5137/swagger/index.html。它的schema地址为http://localhost:5137/swagger/v1/swagger.json。这个地址是我们后面需要用到的地址。然后我们创建一个客户端项目。
openapi 自动生成sdk
10-12
OpenAPI 自动生成 SDK 是一种自动化工具，用于根据 OpenAPI 规范自动生成软件开发包（SDK）的代码。OpenAPI 是一种用于描述和定义 RESTful API 的规范，它提供了一种标准化的方式来描述 API 的终点、参数、请求和...
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值