vite-plugin-swagger-typescript-api-transform 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Anthony Fu <https://github.com/antfu>
+
+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.

package/README.md

@@ -0,0 +1,195 @@
+# vite-plugin-swagger-typescript-api
+
+[![NPM version](https://img.shields.io/npm/v/vite-plugin-swagger-typescript-api?color=a1b858&label=)](https://npm.npmjs.com/package/vite-plugin-swagger-typescript-api)
+
+基于 [unplugin](https://github.com/unjs/unplugin) 的插件，构建时自动扫描 Swagger/OpenAPI YAML 文件生成 TypeScript API 客户端。支持 Vite、Rollup、Webpack、Rspack、Nuxt、esbuild、Farms、Astro 等。
+
+## 安装
+
+```bash
+npm i vite-plugin-swagger-typescript-api
+```
+
+## 快速开始
+
+1. 项目根目录创建 `yaml/` 文件夹，放入 Swagger YAML 文件
+2. 配置插件
+3. 自动生成 `src/api/` 下的 TypeScript API 代码
+
+## 配置选项
+
+```ts
+SwaggerTSApi({
+  rootDir?: string           // 扫描根目录，默认 process.cwd()
+  outputDir?: string        // 输出目录，默认 'src/api'
+  generateClient?: boolean  // 生成请求函数，默认 true
+  httpClient?: 'fetch' | 'axios'  // HTTP 客户端，默认 'fetch'
+  baseURL?: string          // API 基础 URL（生成 request.ts）
+  watch?: boolean           // 监听文件变化，默认 true
+  moduleNameFormat?: 'kebab' | 'camel' | 'pascal'  // 模块名格式，默认 'kebab'
+})
+```
+
+## 构建工具集成
+
+### Vite
+
+```ts
+// vite.config.ts
+import SwaggerTSApi from 'vite-plugin-swagger-typescript-api'
+
+export default {
+  plugins: [SwaggerTSApi({ outputDir: 'src/api' })]
+}
+```
+
+### Rollup
+
+```ts
+import SwaggerTSApi from 'vite-plugin-swagger-typescript-api/rollup'
+
+export default { plugins: [SwaggerTSApi({ outputDir: 'src/api' })] }
+```
+
+### Webpack
+
+```js
+const SwaggerTSApi = require('vite-plugin-swagger-typescript-api/webpack')
+
+module.exports = {
+  plugins: [new SwaggerTSApi({ outputDir: 'src/api' })]
+}
+```
+
+### Rspack
+
+```ts
+import SwaggerTSApi from 'vite-plugin-swagger-typescript-api/rspack'
+
+export default { plugins: [SwaggerTSApi({ outputDir: 'src/api' })] }
+```
+
+### Nuxt
+
+```ts
+// nuxt.config.ts
+export default {
+  modules: ['vite-plugin-swagger-typescript-api/nuxt'],
+  swaggerTsApi: { outputDir: 'src/api' }
+}
+```
+
+### Vue CLI
+
+```js
+// vue.config.js
+module.exports = {
+  configureWebpack: {
+    plugins: [new (require('vite-plugin-swagger-typescript-api/webpack'))({})]
+  }
+}
+```
+
+### esbuild
+
+```ts
+import { build } from 'esbuild'
+import SwaggerTSApi from 'vite-plugin-swagger-typescript-api/esbuild'
+
+build({ plugins: [SwaggerTSApi({})] })
+```
+
+### Farm
+
+```ts
+import SwaggerTSApi from 'vite-plugin-swagger-typescript-api/farm'
+
+export default { plugins: [SwaggerTSApi({})] }
+```
+
+### Astro
+
+```ts
+// astro.config.mjs
+import SwaggerTSApi from 'vite-plugin-swagger-typescript-api'
+
+export default {
+  vite: { plugins: [SwaggerTSApi({ outputDir: 'src/api' })] }
+}
+```
+
+## 部署项目
+
+### 构建
+
+```bash
+# 开发环境（带 watch 模式，自动重新生成 API）
+npm run dev
+
+# 生产构建
+npm run build
+```
+
+### 生成产物
+
+插件在 **构建时** 生成 API 代码到 `outputDir`，生成的代码是普通 TypeScript，无需特殊处理：
+
+```bash
+# 构建后 src/api/ 目录结构示例
+src/api/
+├── index.ts              # 统一入口
+├── request.ts            # HTTP 客户端（配置 baseURL 时生成）
+├── user/                 # 根据 yaml/user.yaml 生成
+│   ├── Api.ts
+│   ├── index.ts
+│   └── example.ts
+└── product/
+    ├── Api.ts
+    ├── index.ts
+    └── example.ts
+```
+
+### 提交到 Git
+
+建议将 `outputDir`（如 `src/api`）**一起提交**，因为：
+- API 代码由 YAML 驱动，提交后可追溯
+- 团队成员无需运行插件即可开发
+- 构建时即使 YAML 解析失败也有可用代码
+
+如果只想在构建时生成，可将 `src/api` 加入 `.gitignore`：
+
+```gitignore
+# 取消注释如果你不希望提交生成的 API 代码
+# src/api/
+```
+
+### CI/CD 注意事项
+
+确保 CI 环境安装依赖后执行构建命令：
+
+```yaml
+# .github/workflows/deploy.yml 示例
+- uses: actions/checkout@v4
+- uses: pnpm/action-setup@v4
+- run: pnpm install
+- run: pnpm run build  # 插件在此阶段生成 API 代码
+```
+
+## 项目架构
+
+```
+src/
+├── index.ts           # 插件入口
+├── types.ts          # 类型定义
+├── utils.ts          # 工具函数
+├── core/             # 核心模块
+│   ├── constants.ts  # 常量
+│   ├── plugin.ts     # unplugin 工厂
+│   ├── scanner.ts    # 扫描协调
+│   └── generator.ts  # API 生成
+└── generators/       # 代码生成器
+    ├── example.ts
+    ├── module-index.ts
+    ├── entry-index.ts
+    └── request.ts
+```

package/dist/astro.d.ts

@@ -0,0 +1,7 @@
+import { Options } from "./types-CpgPraRT.js";
+
+//#region src/astro.d.ts
+declare const _default: (options: Options) => any;
+
+//#endregion
+export { _default as default };

package/dist/astro.js

@@ -0,0 +1,14 @@
+import { unplugin } from "./src-DPpaOQvV.js";
+import "./utils-BypLbD1p.js";
+
+//#region src/astro.ts
+var astro_default = (options) => ({
+	name: "unplugin-starter",
+	hooks: { "astro:config:setup": async (astro) => {
+		astro.config.vite.plugins ||= [];
+		astro.config.vite.plugins.push(unplugin.vite(options));
+	} }
+});
+
+//#endregion
+export { astro_default as default };

package/dist/esbuild.d.ts

@@ -0,0 +1,8 @@
+import { Options } from "./types-CpgPraRT.js";
+import * as esbuild13 from "esbuild";
+
+//#region src/esbuild.d.ts
+declare const _default: (options?: Options | undefined) => esbuild13.Plugin;
+
+//#endregion
+export { _default as default };

package/dist/esbuild.js

@@ -0,0 +1,9 @@
+import { unpluginFactory } from "./src-DPpaOQvV.js";
+import "./utils-BypLbD1p.js";
+import { createEsbuildPlugin } from "unplugin";
+
+//#region src/esbuild.ts
+var esbuild_default = createEsbuildPlugin(unpluginFactory);
+
+//#endregion
+export { esbuild_default as default };

package/dist/farm.d.ts

@@ -0,0 +1,8 @@
+import { Options } from "./types-CpgPraRT.js";
+import * as _farmfe_core1 from "@farmfe/core";
+
+//#region src/farm.d.ts
+declare const _default: (options?: Options | undefined) => _farmfe_core1.JsPlugin;
+
+//#endregion
+export { _default as default };

package/dist/farm.js

@@ -0,0 +1,9 @@
+import { unpluginFactory } from "./src-DPpaOQvV.js";
+import "./utils-BypLbD1p.js";
+import { createFarmPlugin } from "unplugin";
+
+//#region src/farm.ts
+var farm_default = createFarmPlugin(unpluginFactory);
+
+//#endregion
+export { farm_default as default };

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { HttpClientType, MergedOptions, Options } from "./types-CpgPraRT.js";
+import * as unplugin14 from "unplugin";
+import { UnpluginFactory } from "unplugin";
+
+//#region src/core/constants.d.ts
+declare const PLUGIN_NAME = "swagger-typescript-api";
+declare const DEFAULT_OPTIONS: MergedOptions;
+
+//#endregion
+//#region src/core/plugin.d.ts
+/**
+ * 插件工厂函数
+ */
+declare const unpluginFactory: UnpluginFactory<Options | undefined>;
+declare const unplugin: unplugin14.UnpluginInstance<Options | undefined, boolean>;
+
+//#endregion
+export { DEFAULT_OPTIONS, HttpClientType, MergedOptions, Options, PLUGIN_NAME, unplugin as default, unplugin, unpluginFactory };

package/dist/index.js

@@ -0,0 +1,4 @@
+import { DEFAULT_OPTIONS, PLUGIN_NAME, unplugin, unpluginFactory } from "./src-DPpaOQvV.js";
+import "./utils-BypLbD1p.js";
+
+export { DEFAULT_OPTIONS, PLUGIN_NAME, unplugin as default, unplugin, unpluginFactory };

package/dist/nuxt.d.ts

@@ -0,0 +1,9 @@
+import { Options } from "./types-CpgPraRT.js";
+import * as _nuxt_schema10 from "@nuxt/schema";
+
+//#region src/nuxt.d.ts
+interface ModuleOptions extends Options {}
+declare const _default: _nuxt_schema10.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+//#endregion
+export { ModuleOptions, _default as default };

package/dist/nuxt.js

@@ -0,0 +1,21 @@
+import "./src-DPpaOQvV.js";
+import "./utils-BypLbD1p.js";
+import { vite_default } from "./vite-BKknryyS.js";
+import { webpack_default } from "./webpack-9obP3bLC.js";
+import { addVitePlugin, addWebpackPlugin, defineNuxtModule } from "@nuxt/kit";
+
+//#region src/nuxt.ts
+var nuxt_default = defineNuxtModule({
+	meta: {
+		name: "nuxt-unplugin-starter",
+		configKey: "unpluginStarter"
+	},
+	defaults: {},
+	setup(options, _nuxt) {
+		addVitePlugin(() => vite_default(options));
+		addWebpackPlugin(() => webpack_default(options));
+	}
+});
+
+//#endregion
+export { nuxt_default as default };