1 Star 2 Fork 0

LileyZhao/swagger-api-build-script

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Swagger API 代码生成工具

这是一个简单的 NodeJS 脚本工具,用于在本地从 Swagger/OpenAPI 规范接口构建生成 TypeScript API 客户端代码。

效果预览

使用方法

  1. 复制完整的 api-build 目录到你的前端项目目录中
  2. 根据你的OS,删除 api-build/jre 目录下多余的 jre 压缩包。例如: Windows 系统仅需保留 jre11_x64_windows.zip,其他 3 个 jre 压缩包可以删除,jre 压缩包无需解压,脚本会自动处理。
  3. 如果不想提交 jre文件,请记得把 jre 目录添加到 .gitignore
  4. 工具不需要安装和配置 Java 环境

基本命令格式:

node api-build/build.js <swagger-url> <output-directory>

脚本使用示例:

node api-build/build.js "https://petstore.swagger.io/v2/swagger.json" "src/apis"

package.json 快捷方式:

{
  "scripts": {
    "build:api": "node api-build/build.js \"https://petstore.swagger.io/v2/swagger.json\" \"src/apis\""
  },
}
pnpm build:api

注意: swagger-url 本地使用https https://localhost:xxx 可能会报错,请使用 http://localhost:xxx

环境及依赖

JRE 11 最新版下载指南(可选)

  1. 访问 Adoptium
  2. 在下载页面选择:
    • Version: OpenJDK 11 (LTS)
    • Operating System: 选择您的操作系统
    • Architecture: 选择您的系统架构
    • Package Type: JRE
    • 寻找带有 "Compressed Archive" 或 "zip/tar.gz" 的下载选项
  3. 下载后解压到项目的 api-build/jre/jre11 目录下
MIT License Copyright (c) 2024-PRESENT LileyZhao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一个从 Swagger/OpenAPI 规范构建生成 TypeScript API 客户端代码的脚本工具 展开 收起
README
MIT
取消

发行版 (1)

全部
7个月前

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lileyzhao/swagger-api-build-script.git
git@gitee.com:lileyzhao/swagger-api-build-script.git
lileyzhao
swagger-api-build-script
swagger-api-build-script
main

搜索帮助