使用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使用FFmpeg实现高效音频格式转换工具

《Python使用FFmpeg实现高效音频格式转换工具》在数字音频处理领域,音频格式转换是一项基础但至关重要的功能,本文主要为大家介绍了Python如何使用FFmpeg实现强大功能的图形化音频转换工具... 目录概述功能详解软件效果展示主界面布局转换过程截图完成提示开发步骤详解1. 环境准备2. 项目功能结

SpringBoot使用ffmpeg实现视频压缩

《SpringBoot使用ffmpeg实现视频压缩》FFmpeg是一个开源的跨平台多媒体处理工具集,用于录制,转换,编辑和流式传输音频和视频,本文将使用ffmpeg实现视频压缩功能,有需要的可以参考... 目录核心功能1.格式转换2.编解码3.音视频处理4.流媒体支持5.滤镜(Filter)安装配置linu

Redis中的Lettuce使用详解

《Redis中的Lettuce使用详解》Lettuce是一个高级的、线程安全的Redis客户端,用于与Redis数据库交互,Lettuce是一个功能强大、使用方便的Redis客户端,适用于各种规模的J... 目录简介特点连接池连接池特点连接池管理连接池优势连接池配置参数监控常用监控工具通过JMX监控通过Pr

apache的commons-pool2原理与使用实践记录

《apache的commons-pool2原理与使用实践记录》ApacheCommonsPool2是一个高效的对象池化框架,通过复用昂贵资源(如数据库连接、线程、网络连接)优化系统性能,这篇文章主... 目录一、核心原理与组件二、使用步骤详解(以数据库连接池为例)三、高级配置与优化四、典型应用场景五、注意事

使用Python实现Windows系统垃圾清理

《使用Python实现Windows系统垃圾清理》Windows自带的磁盘清理工具功能有限,无法深度清理各类垃圾文件,所以本文为大家介绍了如何使用Python+PyQt5开发一个Windows系统垃圾... 目录一、开发背景与工具概述1.1 为什么需要专业清理工具1.2 工具设计理念二、工具核心功能解析2.

MySQL 添加索引5种方式示例详解(实用sql代码)

《MySQL添加索引5种方式示例详解(实用sql代码)》在MySQL数据库中添加索引可以帮助提高查询性能,尤其是在数据量大的表中,下面给大家分享MySQL添加索引5种方式示例详解(实用sql代码),... 在mysql数据库中添加索引可以帮助提高查询性能,尤其是在数据量大的表中。索引可以在创建表时定义,也可

Linux系统之stress-ng测压工具的使用

《Linux系统之stress-ng测压工具的使用》:本文主要介绍Linux系统之stress-ng测压工具的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、理论1.stress工具简介与安装2.语法及参数3.具体安装二、实验1.运行8 cpu, 4 fo

Maven项目中集成数据库文档生成工具的操作步骤

《Maven项目中集成数据库文档生成工具的操作步骤》在Maven项目中,可以通过集成数据库文档生成工具来自动生成数据库文档,本文为大家整理了使用screw-maven-plugin(推荐)的完... 目录1. 添加插件配置到 pom.XML2. 配置数据库信息3. 执行生成命令4. 高级配置选项5. 注意事

Java使用MethodHandle来替代反射,提高性能问题

《Java使用MethodHandle来替代反射,提高性能问题》:本文主要介绍Java使用MethodHandle来替代反射,提高性能问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑... 目录一、认识MethodHandle1、简介2、使用方式3、与反射的区别二、示例1、基本使用2、(重要)

使用C#删除Excel表格中的重复行数据的代码详解

《使用C#删除Excel表格中的重复行数据的代码详解》重复行是指在Excel表格中完全相同的多行数据,删除这些重复行至关重要,因为它们不仅会干扰数据分析,还可能导致错误的决策和结论,所以本文给大家介绍... 目录简介使用工具C# 删除Excel工作表中的重复行语法工作原理实现代码C# 删除指定Excel单元