swagger-to-axios 1.0.6 → 1.0.8

package/README.md

@@ -7,50 +7,75 @@
 
 ```TypeScript
 /** swagger 文档配置项 */
-interface SwaggerDocument {
+declare interface SwaggerDocument {
   /** swagger 文档地址 */
   url: string;
-  /** 是否使用本地 swagger 文档，默认为 false。
-   * 如果该项为 true，则 url 应填本地地址，建议填写完整路径 */
-  localFile?: boolean;
-  /** swagger 文档文件类型，yaml 还是 json ，默认为 yaml */
-  urlType?: string;
-  /** 生成文件后该文档的文件夹名称，默认会使用随机数作为文件夹名称 */
+  /** 
+   * 生成文件后该文档的文件夹名称。
+   * 默认值：字符串随机数。
+   * */
   name?: string;
 }
 
 /** 生成文件配置项 */
-interface Config {
-  /** 在生成文件时，每个函数是否携带 baseURL 属性，默认为 true。 */
+declare interface Config {
+  /**
+   * 生成文件时，每个函数是否携带 baseURL 属性。
+   * 默认值：true。
+   * */
   includeBaseURL?: boolean;
   /**
-   * 如果 includeBaseURL 为 false，则不需要配置该项。
-   * cli类型，是 Vite 还是 VueCli ，默认 VueCli。
+   * cli类型。
+   * 默认值：VueCli。
+   * 注：
+   * 1、如果 includeBaseURL 为 false，则不需要配置该项。
    */
-  cliType?: string;
+  cliType?: 'Vite' | 'VueCli';
   /**
-   * 如果 includeBaseURL 为 false，则不需要配置该项。
-   * host 的配置名称，不填时会根据 cliType 属性自动设为 VUE_APP_HOST 或者 VITE_APP_HOST。
-   * 如果 swagger 的 host 填写了正确的地址，你也可以完全不配置该项，生成的代码会使用三目运算符，并将非的表达式设置为 swagger 的 host。
+   * host 的配置名称。
+   * 默认值：VUE_APP_HOST | VITE_APP_HOST（根据 cliType 属性）。
+   * 注：
+   * 1、如果 includeBaseURL 为 false，则不需要配置该项。
+   * 2、如果 swagger 的 host 填写了正确的地址，你也可以完全不配置该项，生成的代码会使用三目运算符，并将非的表达式设置为 swagger 的 host。
    */
   envHostName?: string;
   /**
-   * 如果 includeBaseURL 为 false，则不需要配置该项。
-   * 网络协议的配置名称，不填时会根据 cliType 属性自动设为 VUE_APP_PROTOCOL 或者 VITE_APP_PROTOCOL。
-   * VUE_APP_PROTOCOL / VITE_APP_PROTOCOL 的值应该为 'https' 或者 'http'。
+   * 网络协议的配置名称。
+   * 默认值：VUE_APP_PROTOCOL | VITE_APP_PROTOCOL（根据 cliType 属性）。
+   * 注：
+   * 1、如果 includeBaseURL 为 false，则不需要配置该项。
+   * 2、推荐只在生产环境和开发环境使用不同协议时配置该项。
+   * 3、VUE_APP_PROTOCOL / VITE_APP_PROTOCOL 的值应该为 'https' 或者 'http'。
    */
   envProtocolName?: string;
   /**
-   * 如果 includeBaseURL 为 false，则不需要配置该项。
-   * 是否使用 https，默认为 false。 */
+   * 是否使用 https。
+   * 默认值：false。
+   * 注：
+   * 1、如果 includeBaseURL 为 false，则不需要配置该项。
+   * */
   https?: boolean;
-  /** 生成的文件所在目录，默认为 ./apis。 */
+  /**
+   * 生成的文件所在目录。
+   * 默认值：./apis。
+   * */
   outputFolder?: string;
-  /** 需要引用的 axios 函数地址，默认为 window.axios。 */
+  /**
+   * 需要引用的 axios 函数地址。
+   * 默认值：window.axios。
+   * */
   improtAxiosPath?: string;
-  /** 是否生成 ts 文件，默认为 false。 */
+  /**
+   * 是否生成 ts 文件。
+   * 默认值：false。
+   * */
   typeScript?: boolean;
-  /** url是否放置于 options 中，默认为 true。如为 false，则将放在第一个参数中。 */
+  /**
+   * url是否放置于 options 中。
+   * 默认值：true。
+   * 注：
+   * 1、如为 false，则将放在第一个参数中。
+   * */
   urlInOptions?: boolean;
 }
 ```
@@ -61,25 +86,21 @@ interface Config {
 const swagger2axios = require('swagger-to-axios');
 const swaggerDocumentList = ['name'].map((name) => ({
   url: `http://127.0.0.1:14514/swagger?name=${name}.json`,
-  urlType: 'json',
   name,
 }));
-swagger2axios(swaggerDocumentList,{
-  includeBaseURL: true,
-  cliType: 'Vite',
+swagger2axios(swaggerDocumentList, {
+  includeBaseURL: false,
   improtAxiosPath: '@/utils/request',
-  envProtocolName: 'VITE_APP_SCHEM',
   https: true
 })
 
 /**以下是生成的文件内容*/
 // user.js
 // 用户相关接口
-const basePath = '/api/v1';
-const host = `${import.meta.env.VUE_APP_HOST ? import.meta.env.VUE_APP_HOST : '127.0.0.1:1919'}`;
-const protocol = `${import.meta.env.VITE_APP_SCHEM ? import.meta.env.VITE_APP_SCHEM : 'https'}`;
 import request from '@/utils/request';
 
+const basePath = '/api/v1';
+
 //  获取用户信息
 export function getUserInfo(params, options) {
   return request({

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+import "./types.js";
 /** 创建所有 API 文件
  * @param {SwaggerDocument[]} swaggerList - swagger 文档列表
  * @param {Config} config - 配置项

package/lib/index.js

@@ -1,6 +1,7 @@
 import fs from 'fs';
 const fsPromises = fs.promises;
 import { writeFile, urlToName, urlToLinkParams, getFolderList, } from './utils/index.js';
+import "./types.js";
 /** 创建所有 API 文件
  * @param {SwaggerDocument[]} swaggerList - swagger 文档列表
  * @param {Config} config - 配置项

package/lib/{typeing.d.ts → types.d.ts}

@@ -3,18 +3,7 @@ declare interface SwaggerDocument {
     /** swagger 文档地址 */
     url: string;
     /**
-     * 是否使用本地 swagger 文档。
-     * 默认值：false。
-     * 注：
-     * 1、如果该项为 true，则 url 应填本地地址，建议填写完整路径。
-     * */
-    localFile?: boolean;
-    /**
-     * swagger 文档文件类型。
-     * 默认值：yaml。
-     * */
-    urlType?: 'yaml' | 'json';
-    /** 生成文件后该文档的文件夹名称。
+     * 生成文件后该文档的文件夹名称。
      * 默认值：字符串随机数。
      * */
     name?: string;
@@ -46,7 +35,8 @@ declare interface Config {
      * 默认值：VUE_APP_PROTOCOL | VITE_APP_PROTOCOL（根据 cliType 属性）。
      * 注：
      * 1、如果 includeBaseURL 为 false，则不需要配置该项。
-     * 2、VUE_APP_PROTOCOL / VITE_APP_PROTOCOL 的值应该为 'https' 或者 'http'。
+     * 2、推荐只在生产环境和开发环境使用不同协议时配置该项。
+     * 3、VUE_APP_PROTOCOL / VITE_APP_PROTOCOL 的值应该为 'https' 或者 'http'。
      */
     envProtocolName?: string;
     /**

package/lib/types.js

@@ -0,0 +1 @@
+"use strict";

package/lib/utils/index.d.ts

@@ -1,10 +1,15 @@
 import { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
+/**
+ * 合并 allOf
+ * @param object
+ */
+export declare const expandAllOf: (object: any) => void;
 /** 获取 swagger 文档 */
 export declare const getSwaggerJson: ({ url, }: {
     url: string;
 }) => Promise<OpenAPIV3.Document | OpenAPIV3_1.Document | undefined>;
 /**
-
+ * 获取 swagger 文档列表
  * @param {SwaggerDocument[]} swaggerList - swagger 文档列表
  * @param {Config['cliType']} cliType - cli类型
  * @returns {Promise<Folder[]>} 文件夹数组
@@ -12,12 +17,13 @@ export declare const getSwaggerJson: ({ url, }: {
 export declare const getFolderList: (swaggerList: SwaggerDocument[], cliType: string) => Promise<Folder[]>;
 /** 重组 tag 数组 */
 export declare const getTagList: (tags?: OpenAPIV3.TagObject[], paths?: OpenAPIV3.PathsObject) => Tag[];
+/** 将 openapi 类型转换为 TS 类型 */
+export declare const openapiTypeToTypeScript: (schemaObject: OpenAPIV3.SchemaObject) => string;
 /** 重组 response */
 export declare const getResponse: (response?: OpenAPIV3.ResponseObject) => {
     description: string;
     data?: any;
 } | undefined;
-export declare const openapiTypeToTypeScript: (schemaObject: OpenAPIV3.SchemaObject) => string;
 /**
  * 写文件
  * @param {string} pathname

package/lib/utils/index.js

@@ -3,6 +3,33 @@ import SwaggerParser from '@apidevtools/swagger-parser';
 import { convertObj } from 'swagger2openapi';
 import lodash from 'lodash';
 const mergeWith = lodash.mergeWith;
+/**
+ * 合并 allOf
+ * @param object
+ */
+export const expandAllOf = (object) => {
+    while (object.hasOwnProperty('allOf')) {
+        const allOf = object.allOf;
+        delete object.allOf;
+        const override = mergeWith({}, ...allOf, object, function (target, source) {
+            if (Array.isArray(target)) {
+                return target.concat(source).filter((v, i, a) => a.indexOf(v) === i);
+            }
+            if (typeof target === 'object') {
+                expandAllOf(target);
+            }
+            if (typeof source === 'object') {
+                expandAllOf(source);
+            }
+        });
+        Object.assign(object, override);
+    }
+    Object.keys(object).forEach((key) => {
+        if (typeof object[key] === 'object') {
+            expandAllOf(object[key]);
+        }
+    });
+};
 /** 获取 swagger 文档 */
 export const getSwaggerJson = async ({ url, }) => {
     try {
@@ -20,11 +47,12 @@ export const getSwaggerJson = async ({ url, }) => {
         return swagger;
     }
     catch (error) {
+        console.error(`${url}异常：${error}`);
         return undefined;
     }
 };
 /**
-
+ * 获取 swagger 文档列表
  * @param {SwaggerDocument[]} swaggerList - swagger 文档列表
  * @param {Config['cliType']} cliType - cli类型
  * @returns {Promise<Folder[]>} 文件夹数组
@@ -33,14 +61,14 @@ export const getFolderList = async (swaggerList, cliType) => {
     const result = [];
     for (const element of swaggerList) {
         const { url, name = Math.random().toString() } = element;
-        const json = await getSwaggerJson({ url });
+        const json = await getSwaggerJson({ url, });
         if (json === undefined)
             continue;
         const { tags, paths, servers } = json;
-        const basePath = servers?.[0].url.replace(/.+:\/\/.+\//, '/') ?? '';
+        const basePath = servers?.[0].url.replace(/^.+:\/\/((\d|\w)+\.{0,1})+(:\d+){0,1}/, '') ?? '';
         // 三次替换，分别匹配 http://api.example.com/api , /api , //api.example.com，使结果保持为 api.example.com
         const host = servers?.[0].url
-            .replace(/.+:\/\/(.+)\/.+/, '$1')
+            .replace(/^.+:\/\/(((\d|\w)+\.{0,1})+(:\d+){0,1}).*$/, '$1')
             .replace(/^\/[\w|\d]+/, '')
             .replace(/^\/\//, '') ?? '';
         result.push({
@@ -99,18 +127,7 @@ export const getTagList = (tags = [], paths) => {
     }
     return tagList;
 };
-/** 重组 response */
-export const getResponse = (response) => {
-    if (response === undefined)
-        return response;
-    const result = {
-        description: response.description,
-        data: {},
-    };
-    result.data = openapiTypeToTypeScript(response?.content?.['application/json']?.schema ?? {});
-    console.log('result.data', result.data);
-    return result;
-};
+/** 将 openapi 类型转换为 TS 类型 */
 export const openapiTypeToTypeScript = (schemaObject) => {
     const { type = '' } = schemaObject;
     const numberEnum = [
@@ -177,32 +194,16 @@ export const openapiTypeToTypeScript = (schemaObject) => {
     }
     return 'any';
 };
-/**
- * 合并 allOf
- * @param object
- */
-const expandAllOf = (object) => {
-    while (object.hasOwnProperty('allOf')) {
-        const allOf = object.allOf;
-        delete object.allOf;
-        const override = mergeWith({}, ...allOf, object, function (target, source) {
-            if (Array.isArray(target)) {
-                return target.concat(source).filter((v, i, a) => a.indexOf(v) === i);
-            }
-            if (typeof target === 'object') {
-                expandAllOf(target);
-            }
-            if (typeof source === 'object') {
-                expandAllOf(source);
-            }
-        });
-        Object.assign(object, override);
-    }
-    Object.keys(object).forEach((key) => {
-        if (typeof object[key] === 'object') {
-            expandAllOf(object[key]);
-        }
-    });
+/** 重组 response */
+export const getResponse = (response) => {
+    if (response === undefined)
+        return response;
+    const result = {
+        description: response.description,
+        data: {},
+    };
+    result.data = openapiTypeToTypeScript(response?.content?.['application/json']?.schema ?? {});
+    return result;
 };
 /**
  * 写文件

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-to-axios",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "将swagger转换成axios可用的api文件",
   "main": "lib/index.js",
   "type": "module",