openapi-ts-request 1.12.0 → 1.12.1

package/README.md

@@ -287,6 +287,8 @@ openapi --i ./spec.json --o ./apis
 | exportFormat | string | 指定导出的 OpenAPI 文件的格式，可以有值如 'JSON' 或 'YAML' | 'JSON' |
 | includeApifoxExtensionProperties | boolean | 指定是否包含 Apifox 的 OpenAPI 规范扩展字段 `x-apifox` | false |
 | addFoldersToTags | boolean | 指定是否在标签字段中包含接口的目录名称 | false |
+| branchId | number | 分支ID | false |
+| moduleId | number | 模块ID | false |
 
 ## JSON Schemas
 

package/dist/generator/serviceGenarator.js

@@ -1011,6 +1011,7 @@ class ServiceGenerator {
         return Helper.getProps({
             schemaObject,
             getType: (schema, namespace) => this.getType(schema, namespace),
+            openAPIData: this.openAPIData,
         });
     }
     resolveParameterRef(param) {

package/dist/generator/serviceGeneratorHelper.d.ts

@@ -67,6 +67,7 @@ export declare function resolveAllOfObject(params: {
 export declare function getProps(params: {
     schemaObject: SchemaObject;
     getType: (schema: SchemaObject) => string;
+    openAPIData?: OpenAPIObject;
 }): IPropObject[];
 /**
  * 解析参数引用

package/dist/generator/serviceGeneratorHelper.js

@@ -145,19 +145,36 @@ function resolveAllOfObject(params) {
  */
 function getProps(params) {
     var _a;
-    const { schemaObject, getType } = params;
+    const { schemaObject, getType, openAPIData } = params;
     const requiredPropKeys = (_a = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.required) !== null && _a !== void 0 ? _a : false;
     const properties = schemaObject.properties;
     return (0, lodash_1.keys)(properties).map((propKey) => {
+        var _a, _b;
         const schema = ((properties === null || properties === void 0 ? void 0 : properties[propKey]) || config_2.DEFAULT_SCHEMA);
         // 剔除属性键值中的特殊符号，因为函数入参变量存在特殊符号会导致解析文件失败
         // eslint-disable-next-line no-useless-escape
         propKey = propKey.replace(/[\[|\]]/g, '');
+        // 获取描述信息，如果是 $ref 引用，尝试获取引用对象的描述
+        let desc = [schema.title, schema.description]
+            .filter((item) => item)
+            .join(' ')
+            .replace(config_2.lineBreakReg, '');
+        // 如果是 $ref 引用，尝试获取引用对象的描述
+        if ((0, util_1.isReferenceObject)(schema) && openAPIData) {
+            const refName = (0, util_1.getLastRefName)(schema.$ref);
+            const refSchema = (_b = (_a = openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas) === null || _b === void 0 ? void 0 : _b[refName];
+            if (refSchema) {
+                const refDesc = [refSchema.title, refSchema.description]
+                    .filter((item) => item)
+                    .join(' ')
+                    .replace(config_2.lineBreakReg, '');
+                if (refDesc) {
+                    desc = desc + refDesc;
+                }
+            }
+        }
         // 复用 schema 部分字段
-        return Object.assign(Object.assign({}, schema), { name: propKey, type: getType(schema), desc: [schema.title, schema.description]
-                .filter((item) => item)
-                .join(' ')
-                .replace(config_2.lineBreakReg, ''), 
+        return Object.assign(Object.assign({}, schema), { name: propKey, type: getType(schema), desc: desc, 
             // 如果没有 required 信息，默认全部是非必填
             required: requiredPropKeys
                 ? requiredPropKeys.some((key) => key === propKey)

package/dist/type.d.ts

@@ -96,13 +96,15 @@ export interface APIFoxBody {
     oasVersion?: '2.0' | '3.0' | '3.1';
     exportFormat?: 'JSON' | 'YAML';
     environmentIds?: string[];
+    branchId?: number;
+    moduleId?: number;
 }
-export interface GetSchemaByApifoxProps extends Pick<APIFoxBody, 'oasVersion' | 'exportFormat'>, Pick<APIFoxBody['options'], 'includeApifoxExtensionProperties' | 'addFoldersToTags'> {
+export type GetSchemaByApifoxProps = {
     projectId: string;
     apifoxToken: string;
     locale?: string;
     apifoxVersion?: string;
     selectedTags?: string[];
     excludedByTags?: string[];
-}
+} & Pick<APIFoxBody, 'oasVersion' | 'exportFormat' | 'branchId' | 'moduleId'> & APIFoxBody['options'];
 export {};

package/dist/util.js

@@ -32,7 +32,7 @@ exports.getImportStatement = getImportStatement;
  * @param params.apifoxVersion {string} apifox 版本 目前固定为 2024-03-28 可通过 https://api.apifox.com/v1/versions 获取最新版本
  * @returns
  */
-const getSchemaByApifox = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ projectId, locale = 'zh-CN', apifoxVersion = '2024-03-28', selectedTags, excludedByTags = [], apifoxToken, oasVersion = '3.0', exportFormat = 'JSON', includeApifoxExtensionProperties = false, addFoldersToTags = false, }) {
+const getSchemaByApifox = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ projectId, locale = 'zh-CN', apifoxVersion = '2024-03-28', selectedTags, excludedByTags = [], apifoxToken, oasVersion = '3.0', exportFormat = 'JSON', includeApifoxExtensionProperties = false, addFoldersToTags = false, branchId, moduleId, }) {
     try {
         const body = {
             scope: {
@@ -45,6 +45,12 @@ const getSchemaByApifox = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, functi
             oasVersion,
             exportFormat,
         };
+        if (branchId !== undefined) {
+            body.branchId = branchId;
+        }
+        if (moduleId !== undefined) {
+            body.moduleId = moduleId;
+        }
         const tags = !(0, lodash_1.isEmpty)(selectedTags) ? selectedTags : '*';
         if (tags === '*') {
             body.scope.type = 'ALL';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "description": "Swagger2/OpenAPI3/Apifox to TypeScript/JavaScript, request client(support any client), request mock service, enum and enum translation, react-query/vue-query, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",

package/templates/enum.njk

@@ -4,6 +4,9 @@
 {%- if list.length > 0 %}
   {% for type in list -%}
     {%- if type.isEnum  %}
+      {%- if type.description%} 
+      /** {{ type.description }} */
+      {%- endif %}
       export enum {{ type.typeName | safe }} {{ type.type }};
 
       export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}

package/templates/interface.njk

@@ -43,6 +43,9 @@
       {%- endfor %}
     {%- else %}
       {%- if type.isEnum  %}
+        {%- if type.description%} 
+        /** {{ type.description }} */
+        {%- endif %}
         export enum {{ type.typeName | safe }} {{ type.type }};
 
         export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}