openapi-ts-request 1.3.1 → 1.3.2

package/README.md

@@ -264,17 +264,22 @@ openapi --i ./spec.json --o ./apis
 | customClassName | (tagName: string) => string | 自定义标签名 |
 | customType | ({<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string, schemas?: ComponentsObject['schemas']) => string,<br>schemas?: ComponentsObject['schemas'],<br>}) => string | 自定义类型 <br> _返回非字符串将使用默认方法获取type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | 自定义生成的请求客户端文件名称，可以返回多个文件名称的数组(表示生成多个文件). <br> _返回为空，则使用默认的方法获取_ |
+| customTemplates | {<br>[TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;<br>} | 自定义模板，详情请看源码 |
 
 ## Apifox-Config
 
 | 属性 | 类型 | 说明 | 必填 |
 | --- | --- | --- | --- |
 | projectId | string | 项目id | true |
-| local | string | 语言(默认:zh-CN) | false |
+| apifoxToken | string | [获取](https://docs.apifox.com/doc-5723694) | true |
+| local | string | 语言(默认: zh-CN) | false |
 | apifoxVersion | string | 默认: 2024-03-28, [获取当前版本](https://api.apifox.com/v1/versions) | false |
 | includeTags | \* 或 string[] | 默认: \* | false |
 | excludeTags | string[] | 默认: [] | false |
-| apifoxToken | string | [获取](https://docs.apifox.com/doc-5723694) | true |
+| oasVersion | string | 指定用于导出的 OpenAPI 规范的版本，可以有值如 "2.0"、"3.0"、"3.1" | '3.0' |
+| exportFormat | string | 指定导出的 OpenAPI 文件的格式，可以有值如 'JSON' 或 'YAML' | 'JSON' |
+| includeApifoxExtensionProperties | boolean | 指定是否包含 Apifox 的 OpenAPI 规范扩展字段 `x-apifox` | false |
+| addFoldersToTags | boolean | 指定是否在标签字段中包含接口的目录名称 | false |
 
 ## JSON Schemas
 

package/dist/generator/serviceGenarator.js

@@ -183,9 +183,21 @@ class ServiceGenerator {
             const prettierError = [];
             // 生成 service controller 文件
             this.getServiceTPConfigs().forEach((tp) => {
+                var _a, _b;
+                const { list } = tp, restTp = tslib_1.__rest(tp, ["list"]);
+                const payload = Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_2.interfaceFileName, list }, restTp);
+                const hookCustomTemplateService = (_b = (_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customTemplates) === null || _b === void 0 ? void 0 : _b[config_2.TypescriptFileType.serviceController];
+                if (hookCustomTemplateService) {
+                    payload.list = list.map((item) => {
+                        return {
+                            customTemplate: true,
+                            data: hookCustomTemplateService(item, payload),
+                        };
+                    });
+                }
                 const hasError = this.genFileFromTemplate(isGenJavaScript
                     ? (0, util_2.getFinalFileName)(`${tp.className}.js`)
-                    : (0, util_2.getFinalFileName)(`${tp.className}.ts`), config_2.TypescriptFileType.serviceController, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_2.interfaceFileName }, tp));
+                    : (0, util_2.getFinalFileName)(`${tp.className}.ts`), config_2.TypescriptFileType.serviceController, payload);
                 prettierError.push(hasError);
                 if (this.config.isGenReactQuery) {
                     this.genFileFromTemplate(isGenJavaScript

package/dist/generator/type.d.ts

@@ -50,4 +50,14 @@ type MergerOptionProps = {
     projectOptions: ProjectOptions;
 };
 export type MergerOptions = MergeOption & Partial<MergerOptionProps>;
+export type IServiceControllerPayload<T> = {
+    namespace: string;
+    requestOptionsType: string;
+    requestImportStatement: string;
+    interfaceFileName: string;
+    list: {
+        customTemplate: boolean;
+        data: string;
+    }[] | T;
+};
 export {};

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { TypescriptFileType } from './generator/config';
 import { APIDataType } from './generator/type';
 import { ComponentsObject, type GetSchemaByApifoxProps, IPriorityRule, IReactQueryMode, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
 export * from './generator/patchSchema';
@@ -194,6 +195,15 @@ export type GenerateServiceProps = {
          * }
          */
         customFileNames?: (operationObject: OperationObject, apiPath: string, apiMethod: string) => string[] | null;
+        /**
+         * 自定义模板
+         */
+        customTemplates?: {
+            /**
+             * 自定义 serviceController 模板
+             */
+            [TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;
+        };
     };
 };
 export declare function generateService({ requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, authorization, isTranslateToEnglishTag, priorityRule, timeout, reactQueryMode, apifoxConfig, ...rest }: GenerateServiceProps): Promise<void>;

package/dist/index.js

@@ -4,6 +4,7 @@ exports.generateService = generateService;
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const config_1 = require("./config");
+const config_2 = require("./generator/config");
 const mockGenarator_1 = require("./generator/mockGenarator");
 const serviceGenarator_1 = tslib_1.__importDefault(require("./generator/serviceGenarator"));
 const util_1 = require("./util");

package/dist/readConfig.js

@@ -22,7 +22,6 @@ const readConfig = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({
         else {
             return (yield ((_c = explorerSync.search()) === null || _c === void 0 ? void 0 : _c.config));
         }
-        // eslint-disable-next-line no-unused-vars
     }
     catch (error) {
         return undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "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/serviceController.njk

@@ -8,166 +8,169 @@
 {% endif %}
 
 {% for api in list -%}
-  /** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{ api.method | upper }} {{ api.pathInComment | safe }}{{ ' ' if api.apifoxRunLink else '' }}{{ api.apifoxRunLink }} */
-  export async function {{ api.functionName }}({
-    {%- if api.params and api.hasParams %}
-      params
-      {%- if api.hasParams -%}
-        {{ "," if api.body or api.file }}
-      {%- endif -%}
-    {%- endif -%}
-    {%- if api.body -%}
-      body
-      {{ "," if api.file }}
-    {%- endif %}
-    {%- if api.file -%}
-      {%- for file in api.file -%}
-        {{ file.title | safe }}
-        {{ "," if not loop.last }}
-      {%- endfor -%}
-    {%- endif -%}
-    {{ "," if api.body or api.hasParams or api.file }}
-    options
-  }
-  {%- if genType === "ts" -%}
-    : {
+  {% if api.customTemplate %}
+    {{ api.data }}
+  {% else %}
+    /** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{ api.method | upper }} {{ api.pathInComment | safe }}{{ ' ' if api.apifoxRunLink else '' }}{{ api.apifoxRunLink }} */
+    export async function {{ api.functionName }}({
       {%- if api.params and api.hasParams %}
-        // 叠加生成的Param类型 (非body参数openapi默认没有生成对象)
-        params: {{ namespace }}.{{ api.typeName }}
-        {# header 入参 -#}
-        {% if api.params.header -%}
-          & { // header
-          {% for param in api.params.header -%}
-            {% if param.description -%}
-              /** {{ param.description }} */
-            {% endif -%}
-            '{{ param.name }}'
-            {{- "?" if not param.required }}
-            {{- (": " + param.type + ";") | safe }}
-          {% endfor -%}
-          }
-        {%- endif -%}
+        params
         {%- if api.hasParams -%}
-          {{ ";" if api.body or api.file }}
+          {{ "," if api.body or api.file }}
         {%- endif -%}
       {%- endif -%}
-
       {%- if api.body -%}
-        body: 
-        {% if api.body.propertiesList %}
-          {
-          {%- for prop in api.body.propertiesList %}
-            {% if prop.schema.description -%}
-              /** {{ prop.schema.description }} */
-            {% endif -%}
-            '{{ prop.key }}'{{ "?" if not prop.schema.required }}: {{ prop.schema.type }},
-          {%- endfor %}
-          }
-        {%- else -%}
-          {{ api.body.type }}
-        {%- endif -%}
-        {{ ";" if api.file }}
+        body
+        {{ "," if api.file }}
       {%- endif %}
-
       {%- if api.file -%}
         {%- for file in api.file -%}
           {{ file.title | safe }}
-          {{- "?" if not api.file.required -}}
-          : File {{ "[]" if file.multiple }}
-          {{ ";" if not loop.last }}
+          {{ "," if not loop.last }}
         {%- endfor -%}
       {%- endif -%}
-      {{ ";" if api.body or api.hasParams or api.file }}
-      options?: {{ requestOptionsType }}
+      {{ "," if api.body or api.hasParams or api.file }}
+      options
     }
-  {%- endif -%}
-  ) 
-  {
-    {% if api.params and api.params.path %}
-      const { {% for param in api.params.path %}'{{ param.name }}': {{ param.alias }}, {% endfor %}
-      {% if api.params.path -%}
-        ...queryParams
-      {% endif -%}
-      } = params;
-    {% endif %}
-    {%- if api.hasFormData -%}
-      const formData = new FormData();
+    {%- if genType === "ts" -%}
+      : {
+        {%- if api.params and api.hasParams %}
+          // 叠加生成的Param类型 (非body参数openapi默认没有生成对象)
+          params: {{ namespace }}.{{ api.typeName }}
+          {# header 入参 -#}
+          {% if api.params.header -%}
+            & { // header
+            {% for param in api.params.header -%}
+              {% if param.description -%}
+                /** {{ param.description }} */
+              {% endif -%}
+              '{{ param.name }}'
+              {{- "?" if not param.required }}
+              {{- (": " + param.type + ";") | safe }}
+            {% endfor -%}
+            }
+          {%- endif -%}
+          {%- if api.hasParams -%}
+            {{ ";" if api.body or api.file }}
+          {%- endif -%}
+        {%- endif -%}
+
+        {%- if api.body -%}
+          body: 
+          {% if api.body.propertiesList %}
+            {
+            {%- for prop in api.body.propertiesList %}
+              {% if prop.schema.description -%}
+                /** {{ prop.schema.description }} */
+              {% endif -%}
+              '{{ prop.key }}'{{ "?" if not prop.schema.required }}: {{ prop.schema.type }},
+            {%- endfor %}
+            }
+          {%- else -%}
+            {{ api.body.type }}
+          {%- endif -%}
+          {{ ";" if api.file }}
+        {%- endif %}
+
+        {%- if api.file -%}
+          {%- for file in api.file -%}
+            {{ file.title | safe }}
+            {{- "?" if not api.file.required -}}
+            : File {{ "[]" if file.multiple }}
+            {{ ";" if not loop.last }}
+          {%- endfor -%}
+        {%- endif -%}
+        {{ ";" if api.body or api.hasParams or api.file }}
+        options?: {{ requestOptionsType }}
+      }
+    {%- endif -%}
+    ) 
+    {
+      {% if api.params and api.params.path %}
+        const { {% for param in api.params.path %}'{{ param.name }}': {{ param.alias }}, {% endfor %}
+        {% if api.params.path -%}
+          ...queryParams
+        {% endif -%}
+        } = params;
+      {% endif %}
+      {%- if api.hasFormData -%}
+        const formData = new FormData();
+
+        {% if api.file -%}
+          {% for file in api.file %}
+            if({{ file.title | safe }}) {
+            {% if file.multiple %}
+              {{ file.title | safe }}.forEach(f => formData.append('{{ file.title | safe }}', f || ''));
+            {% else %}
+              formData.append('{{ file.title | safe }}', {{ file.title | safe }})
+            {% endif %}
+            }
+          {% endfor %}
+        {%- endif -%}
 
-      {% if api.file -%}
-        {% for file in api.file %}
-          if({{ file.title | safe }}) {
-          {% if file.multiple %}
-            {{ file.title | safe }}.forEach(f => formData.append('{{ file.title | safe }}', f || ''));
+        {% if api.body %}
+          Object.keys(body).forEach(ele => {
+          {% if genType === "ts" %}
+            const item = (body as { [key: string]: any })[ele];
           {% else %}
-            formData.append('{{ file.title | safe }}', {{ file.title | safe }})
+            const item = body[ele];
           {% endif %}
-          }
-        {% endfor %}
-      {%- endif -%}
-
-      {% if api.body %}
-        Object.keys(body).forEach(ele => {
-        {% if genType === "ts" %}
-          const item = (body as { [key: string]: any })[ele];
-        {% else %}
-          const item = body[ele];
-        {% endif %}
-          if (item !== undefined && item !== null) {
-            {% if genType === "ts" %}
-              if (typeof item === 'object' && !(item instanceof File)) {
-                if (item instanceof Array) {
-                  item.forEach((f) => formData.append(ele, f || ''));
+            if (item !== undefined && item !== null) {
+              {% if genType === "ts" %}
+                if (typeof item === 'object' && !(item instanceof File)) {
+                  if (item instanceof Array) {
+                    item.forEach((f) => formData.append(ele, f || ''));
+                  } else {
+                    formData.append(ele, JSON.stringify(item));
+                  }
                 } else {
-                  formData.append(ele, JSON.stringify(item));
+                  formData.append(ele, item);
                 }
-              } else {
-                formData.append(ele, item);
-              }
-            {% else %}
-              formData.append(ele, typeof item === 'object' ? JSON.stringify(item) : item);
-            {% endif %}
-          }
-        });
+              {% else %}
+                formData.append(ele, typeof item === 'object' ? JSON.stringify(item) : item);
+              {% endif %}
+            }
+          });
+        {% endif %}
       {% endif %}
-    {% endif %}
 
-    {% if api.hasPathVariables or api.hasApiPrefix -%}
-      return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}(`{{ api.path | safe }}`, {
-    {% else -%}
-      return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}('{{ api.path }}', {
-    {% endif -%}
-      method: '{{ api.method | upper }}',
-      {%- if api.hasHeader and api.body.mediaType %}
-        headers: {
-          {%- if api.body.mediaType %}
-          'Content-Type': '{{ api.body.mediaType | safe }}',
-          {%- endif %}
-        },
-      {%- endif %}
-      {%- if api.params and api.hasParams %}
-        params: {
-          {%- for query in api.params.query %}
-            {% if query.schema.default -%}
-              // {{ query.name | safe }} has a default value: {{ query.schema.default | safe }}
-              '{{ query.name | safe }}': '{{query.schema.default | safe}}',
-            {%- endif -%}
-          {%- endfor -%}
-          ...{{ 'queryParams' if api.params and api.params.path else 'params' }},
-          {%- for query in api.params.query %}
-            {%- if query.isComplexType %}
-              '{{ query.name | safe }}': undefined,
-              ...{{ 'queryParams' if api.params and api.params.path else 'params' }}['{{ query.name | safe }}'],
+      {% if api.hasPathVariables or api.hasApiPrefix -%}
+        return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}(`{{ api.path | safe }}`, {
+      {% else -%}
+        return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}('{{ api.path }}', {
+      {% endif -%}
+        method: '{{ api.method | upper }}',
+        {%- if api.hasHeader and api.body.mediaType %}
+          headers: {
+            {%- if api.body.mediaType %}
+            'Content-Type': '{{ api.body.mediaType | safe }}',
             {%- endif %}
-          {%- endfor -%}
-        },
-      {%- endif %}
-      {%- if api.hasFormData %}
-        data: formData,
-      {%- elseif api.body %}
-        data: body,
-      {%- endif %}
-      ...(options || {{ api.options | dump }}),
-    });
-  }
-
+          },
+        {%- endif %}
+        {%- if api.params and api.hasParams %}
+          params: {
+            {%- for query in api.params.query %}
+              {% if query.schema.default -%}
+                // {{ query.name | safe }} has a default value: {{ query.schema.default | safe }}
+                '{{ query.name | safe }}': '{{query.schema.default | safe}}',
+              {%- endif -%}
+            {%- endfor -%}
+            ...{{ 'queryParams' if api.params and api.params.path else 'params' }},
+            {%- for query in api.params.query %}
+              {%- if query.isComplexType %}
+                '{{ query.name | safe }}': undefined,
+                ...{{ 'queryParams' if api.params and api.params.path else 'params' }}['{{ query.name | safe }}'],
+              {%- endif %}
+            {%- endfor -%}
+          },
+        {%- endif %}
+        {%- if api.hasFormData %}
+          data: formData,
+        {%- elseif api.body %}
+          data: body,
+        {%- endif %}
+        ...(options || {{ api.options | dump }}),
+      });
+    }
+  {% endif %}
 {% endfor -%}