使用openapi直接生成service代码

2024-06-13 02:04

本文主要是介绍使用openapi直接生成service代码,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

步骤:

1)进入openapi的GitHub地址:https://github.com/ferdikoomen/openapi-typescript-codegen

2)下载openapi插件

npm下载:
npm install openapi-typescript-codegen --save-dev
yarn下载:
yarn add openapi-typescript-codegen --save-dev

如果下载出现报错,去排查是否是npm或者yarn的环境变量没有配置好。

3)生成代码:是使用 openapi-typescript-codegen 工具生成客户端代码。具体来说,它们从 OpenAPI 规范文件(API 描述文件)生成 TypeScript 客户端代码库。

示例一:

openapi --input ./spec.json --output ./generated
详细解释:
  • openapi: 这是 openapi-typescript-codegen 工具的可执行命令。
  • --input ./spec.json: 指定输入文件,这里是当前目录下的 spec.json 文件。这个文件包含了 OpenAPI 规范,描述了 API 的端点、请求和响应格式等。
  • --output ./generated: 指定输出目录,这里是当前目录下的 generated 文件夹。生成的 TypeScript 客户端代码将被放在这个目录中。

示例二:

openapi --input ./spec.json --output ./generated --client xhr
详细解释:
  • openapi: 这是 openapi-typescript-codegen 工具的可执行命令。
  • --input ./spec.json: 指定输入文件,这里是当前目录下的 spec.json 文件。
  • --output ./generated: 指定输出目录,这里是当前目录下的 generated 文件夹。
  • --client xhr: 指定生成的客户端代码使用 xhr(XMLHttpRequest)库来发起 HTTP 请求。xhr 是一种基于浏览器的 HTTP 请求方法,与较老的浏览器兼容。

示例三:

openapi --input http://localhost:8121/api/v2/api-docs --output ./generated --client axios

使用 openapi-typescript-codegen 工具从指定的 OpenAPI 规范 URL 生成使用 axios 库的 TypeScript 客户端代码。

详细解释:

  • --input http://localhost:8121/api/v2/api-docs:这是指定输入文件的参数。这里输入的不是一个本地文件,而是一个 URL。该 URL 指向一个 OpenAPI 规范文档,这个文档描述了 API 的端点、请求和响应格式等。在这个示例中,文档位于 http://localhost:8121/api/v2/api-docs

  • --output ./generated:这是指定输出目录的参数。生成的 TypeScript 客户端代码将被放在当前目录下的 generated 文件夹中。

  • --client axios:这是指定生成代码使用的 HTTP 客户端库的参数。这里指定使用 axios,这是一种基于 Promise 的 HTTP 客户端,用于浏览器和 Node.js

报错解决办法1:

如果出现openapi命令不可用,但是排除了环境变量的问题,可以使用完整路径执行命令:

在确认路径正确添加之前,可以尝试使用 openapi-generator-cli 的完整路径来执行命令。

例如:

%USERPROFILE%\AppData\Local\Yarn\bin\openapi-generator-cli.cmd generate -i http://localhost:8121/api/v2/api-docs -g typescript-axios -o ./generated

报错解决办法2:

如何还是无法解决,检查可执行文件名称。你安装了 openapi-typescript-codegen,该工具的可执行文件可能不叫 openapi,而是 openapi-generator-cliopenapi-typescript-codegen

尝试以下命令之一:

使用 openapi-generator-cli(如果是这个包)
openapi-generator-cli generate -i http://localhost:8121/api/v2/api-docs -g typescript-axios -o ./generated
使用 openapi-typescript-codegen
npx openapi-typescript-codegen --input http://localhost:8121/api/v2/api-docs --output ./generated --client axios

或者

%USERPROFILE%\AppData\Local\Yarn\bin\openapi-typescript-codegen.cmd --input http://localhost:8121/api/v2/api-docs --output ./generated --client axios

这篇关于使用openapi直接生成service代码的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1055981

相关文章

Java Stream流与使用操作指南

《JavaStream流与使用操作指南》Stream不是数据结构,而是一种高级的数据处理工具,允许你以声明式的方式处理数据集合,类似于SQL语句操作数据库,本文给大家介绍JavaStream流与使用... 目录一、什么是stream流二、创建stream流1.单列集合创建stream流2.双列集合创建str

Python使用FastAPI实现大文件分片上传与断点续传功能

《Python使用FastAPI实现大文件分片上传与断点续传功能》大文件直传常遇到超时、网络抖动失败、失败后只能重传的问题,分片上传+断点续传可以把大文件拆成若干小块逐个上传,并在中断后从已完成分片继... 目录一、接口设计二、服务端实现(FastAPI)2.1 运行环境2.2 目录结构建议2.3 serv

C#实现千万数据秒级导入的代码

《C#实现千万数据秒级导入的代码》在实际开发中excel导入很常见,现代社会中很容易遇到大数据处理业务,所以本文我就给大家分享一下千万数据秒级导入怎么实现,文中有详细的代码示例供大家参考,需要的朋友可... 目录前言一、数据存储二、处理逻辑优化前代码处理逻辑优化后的代码总结前言在实际开发中excel导入很

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security?—— 核心思想二、如何在 Java 项目中使用?——

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot?二、环境准备与部署2.1 安装 RustF

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。

Python实现Excel批量样式修改器(附完整代码)

《Python实现Excel批量样式修改器(附完整代码)》这篇文章主要为大家详细介绍了如何使用Python实现一个Excel批量样式修改器,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一... 目录前言功能特性核心功能界面特性系统要求安装说明使用指南基本操作流程高级功能技术实现核心技术栈关键函

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC

使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解

《使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解》本文详细介绍了如何使用Python通过ncmdump工具批量将.ncm音频转换为.mp3的步骤,包括安装、配置ffmpeg环... 目录1. 前言2. 安装 ncmdump3. 实现 .ncm 转 .mp34. 执行过程5. 执行结

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java