OpenAPI Typescript Codegen 的基本使用

下载 axios

npm install axios

OpenAPI Typescript Codegen 官网:https://github.com/ferdikoomen/openapi-typescript-codegen

安装 OpenAPI Typescript Codegen

npm install openapi-typescript-codegen --save-dev

–input:指定接口文档的路径、url 或字符串内容(必填)

–output:代码生成的目录

–client:生成的代码所需要使用的请求库

准备 OpenAPI 规范文件

在你的项目中,准备一个符合 OpenAPI 规范的 JSON (OpenAPI 格式 / Swagger / Slf4j 接口文档的导出格式都是 JSON)或 YAML 文件。该文件描述了你的 API 的端点、参数、响应等信息。

接口文档

生成 TypeScript 代码

在终端或命令提示符中,使用以下命令生成 TypeScript 代码:

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

这里的 http://localhost:8121/api//v2/api-docs 是你准备的 OpenAPI 规范文件的路径,./generated 是生成的 TypeScript 代码的输出路径。你可以根据需要自定义这些路径。

在这里插入图片描述

  • 2
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小秀_heo

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值