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

相关文章

nginx生成自签名SSL证书配置HTTPS的实现

《nginx生成自签名SSL证书配置HTTPS的实现》本文主要介绍在Nginx中生成自签名SSL证书并配置HTTPS,包括安装Nginx、创建证书、配置证书以及测试访问,具有一定的参考价值,感兴趣的可... 目录一、安装nginx二、创建证书三、配置证书并验证四、测试一、安装nginxnginx必须有"-

Python中conda虚拟环境创建及使用小结

《Python中conda虚拟环境创建及使用小结》本文主要介绍了Python中conda虚拟环境创建及使用小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们... 目录0.前言1.Miniconda安装2.conda本地基本操作3.创建conda虚拟环境4.激活c

Spring中@Lazy注解的使用技巧与实例解析

《Spring中@Lazy注解的使用技巧与实例解析》@Lazy注解在Spring框架中用于延迟Bean的初始化,优化应用启动性能,它不仅适用于@Bean和@Component,还可以用于注入点,通过将... 目录一、@Lazy注解的作用(一)延迟Bean的初始化(二)与@Autowired结合使用二、实例解

SpringBoot使用Jasypt对YML文件配置内容加密的方法(数据库密码加密)

《SpringBoot使用Jasypt对YML文件配置内容加密的方法(数据库密码加密)》本文介绍了如何在SpringBoot项目中使用Jasypt对application.yml文件中的敏感信息(如数... 目录SpringBoot使用Jasypt对YML文件配置内容进行加密(例:数据库密码加密)前言一、J

Java中有什么工具可以进行代码反编译详解

《Java中有什么工具可以进行代码反编译详解》:本文主要介绍Java中有什么工具可以进行代码反编译的相关资,料,包括JD-GUI、CFR、Procyon、Fernflower、Javap、Byte... 目录1.JD-GUI2.CFR3.Procyon Decompiler4.Fernflower5.Jav

Spring Boot 中正确地在异步线程中使用 HttpServletRequest的方法

《SpringBoot中正确地在异步线程中使用HttpServletRequest的方法》文章讨论了在SpringBoot中如何在异步线程中正确使用HttpServletRequest的问题,... 目录前言一、问题的来源:为什么异步线程中无法访问 HttpServletRequest?1. 请求上下文与线

在 Spring Boot 中使用异步线程时的 HttpServletRequest 复用问题记录

《在SpringBoot中使用异步线程时的HttpServletRequest复用问题记录》文章讨论了在SpringBoot中使用异步线程时,由于HttpServletRequest复用导致... 目录一、问题描述:异步线程操作导致请求复用时 Cookie 解析失败1. 场景背景2. 问题根源二、问题详细分

从零教你安装pytorch并在pycharm中使用

《从零教你安装pytorch并在pycharm中使用》本文详细介绍了如何使用Anaconda包管理工具创建虚拟环境,并安装CUDA加速平台和PyTorch库,同时在PyCharm中配置和使用PyTor... 目录背景介绍安装Anaconda安装CUDA安装pytorch报错解决——fbgemm.dll连接p

Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)

《Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)》文章介绍了如何使用dhtmlx-gantt组件来实现公司的甘特图需求,并提供了一个简单的Vue组件示例,文章还分享了一... 目录一、首先 npm 安装插件二、创建一个vue组件三、业务页面内 引用自定义组件:四、dhtmlx

使用Python创建一个能够筛选文件的PDF合并工具

《使用Python创建一个能够筛选文件的PDF合并工具》这篇文章主要为大家详细介绍了如何使用Python创建一个能够筛选文件的PDF合并工具,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录背景主要功能全部代码代码解析1. 初始化 wx.Frame 窗口2. 创建工具栏3. 创建布局和界面控件4