使用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

相关文章

使用Python和Pyecharts创建交互式地图

《使用Python和Pyecharts创建交互式地图》在数据可视化领域,创建交互式地图是一种强大的方式,可以使受众能够以引人入胜且信息丰富的方式探索地理数据,下面我们看看如何使用Python和Pyec... 目录简介Pyecharts 简介创建上海地图代码说明运行结果总结简介在数据可视化领域,创建交互式地

Java Stream流使用案例深入详解

《JavaStream流使用案例深入详解》:本文主要介绍JavaStream流使用案例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录前言1. Lambda1.1 语法1.2 没参数只有一条语句或者多条语句1.3 一个参数只有一条语句或者多

Java Spring 中 @PostConstruct 注解使用原理及常见场景

《JavaSpring中@PostConstruct注解使用原理及常见场景》在JavaSpring中,@PostConstruct注解是一个非常实用的功能,它允许开发者在Spring容器完全初... 目录一、@PostConstruct 注解概述二、@PostConstruct 注解的基本使用2.1 基本代

C#使用StackExchange.Redis实现分布式锁的两种方式介绍

《C#使用StackExchange.Redis实现分布式锁的两种方式介绍》分布式锁在集群的架构中发挥着重要的作用,:本文主要介绍C#使用StackExchange.Redis实现分布式锁的... 目录自定义分布式锁获取锁释放锁自动续期StackExchange.Redis分布式锁获取锁释放锁自动续期分布式

springboot使用Scheduling实现动态增删启停定时任务教程

《springboot使用Scheduling实现动态增删启停定时任务教程》:本文主要介绍springboot使用Scheduling实现动态增删启停定时任务教程,具有很好的参考价值,希望对大家有... 目录1、配置定时任务需要的线程池2、创建ScheduledFuture的包装类3、注册定时任务,增加、删

使用Python实现矢量路径的压缩、解压与可视化

《使用Python实现矢量路径的压缩、解压与可视化》在图形设计和Web开发中,矢量路径数据的高效存储与传输至关重要,本文将通过一个Python示例,展示如何将复杂的矢量路径命令序列压缩为JSON格式,... 目录引言核心功能概述1. 路径命令解析2. 路径数据压缩3. 路径数据解压4. 可视化代码实现详解1

Pandas透视表(Pivot Table)的具体使用

《Pandas透视表(PivotTable)的具体使用》透视表用于在数据分析和处理过程中进行数据重塑和汇总,本文就来介绍一下Pandas透视表(PivotTable)的具体使用,感兴趣的可以了解一下... 目录前言什么是透视表?使用步骤1. 引入必要的库2. 读取数据3. 创建透视表4. 查看透视表总结前言

Python 交互式可视化的利器Bokeh的使用

《Python交互式可视化的利器Bokeh的使用》Bokeh是一个专注于Web端交互式数据可视化的Python库,本文主要介绍了Python交互式可视化的利器Bokeh的使用,具有一定的参考价值,感... 目录1. Bokeh 简介1.1 为什么选择 Bokeh1.2 安装与环境配置2. Bokeh 基础2

Android使用ImageView.ScaleType实现图片的缩放与裁剪功能

《Android使用ImageView.ScaleType实现图片的缩放与裁剪功能》ImageView是最常用的控件之一,它用于展示各种类型的图片,为了能够根据需求调整图片的显示效果,Android提... 目录什么是 ImageView.ScaleType?FIT_XYFIT_STARTFIT_CENTE

Java学习手册之Filter和Listener使用方法

《Java学习手册之Filter和Listener使用方法》:本文主要介绍Java学习手册之Filter和Listener使用方法的相关资料,Filter是一种拦截器,可以在请求到达Servl... 目录一、Filter(过滤器)1. Filter 的工作原理2. Filter 的配置与使用二、Listen