openapi-ts-request 0.9.0 → 0.11.0

package/README.md

@@ -6,6 +6,8 @@
 
 根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 TS 类型, 客户端请求函数, 模拟请求响应服务, 枚举, 类型字段翻译, JSON Schemas
 
+文档：[使用手册](https://github.com/openapi-ui/openapi-ts-request/issues/100)
+
 ## 功能
 
 - 支持 Swagger2.0/OpenAPI 3.0,3.1 定义
@@ -207,7 +209,7 @@ export declare function patchSchema<T extends object>(
 
 ## 适配uniapp
 
-适配 uniapp 推荐采用自定义 request 函数的方式，你也可以使用 `@uni-helper/axios-adapter` 适配器，详情见 [issue#46](https://github.com/openapi-ui/openapi-ts-request/issues/46)
+适配 uniapp 推荐采用自定义 request 函数的方式，你也可以使用 `@uni-helper/axios-adapter` 适配器，详情见 [【使用手册 2.2】](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
 ## 贡献
 

package/dist/generator/serviceGenarator.js

@@ -145,7 +145,7 @@ class ServiceGenerator {
                 if (!(0, lodash_1.isEmpty)((_a = this.config) === null || _a === void 0 ? void 0 : _a.allowedTags) &&
                     !(0, lodash_1.isEmpty)(operationObject.tags)) {
                     if (!(0, lodash_1.isEmpty)((0, lodash_1.intersection)(this.config.allowedTags, (0, lodash_1.map)(operationObject.tags, (tag) => tag.toLowerCase())))) {
-                        (0, util_1.markAllowSchema)(JSON.stringify(pathItem), schemas);
+                        (0, util_1.markAllowedSchema)(JSON.stringify(pathItem), schemas);
                     }
                     else {
                         return;
@@ -316,7 +316,7 @@ class ServiceGenerator {
                     };
                     return Object.assign(Object.assign({}, newApi), { functionName: this.config.isCamelCase
                             ? (0, lodash_1.camelCase)(functionName)
-                            : functionName, typeName: this.getTypeName(newApi), path: getPrefixPath(), pathInComment: formattedPath.replace(/\*/g, '*'), hasPathVariables: formattedPath.includes('{'), hasApiPrefix: !!this.config.apiPrefix, method: newApi.method, 
+                            : functionName, typeName: this.getTypeName(newApi), path: getPrefixPath(), pathInComment: formattedPath.replace(/\*/g, '*'), apifoxRunLink: newApi === null || newApi === void 0 ? void 0 : newApi['x-run-in-apifox'], hasPathVariables: formattedPath.includes('{'), hasApiPrefix: !!this.config.apiPrefix, method: newApi.method, 
                         // 如果 functionName 和 summary 相同，则不显示 summary
                         desc: functionName === newApi.summary
                             ? (newApi.description || '').replace(config_1.lineBreakReg, '')
@@ -593,7 +593,7 @@ class ServiceGenerator {
     }
     resolveArray(schemaObject) {
         if ((0, util_1.isReferenceObject)(schemaObject.items)) {
-            const refName = (0, util_1.getLastRefName)(schemaObject.items.$ref);
+            const refName = (0, util_1.getRefName)(schemaObject.items);
             return {
                 type: `${refName}[]`,
             };
@@ -607,6 +607,7 @@ class ServiceGenerator {
         };
     }
     resolveEnumObject(schemaObject) {
+        var _a;
         const enumArray = schemaObject.enum;
         let enumStr = '';
         let enumLabelTypeStr = '';
@@ -623,6 +624,12 @@ class ServiceGenerator {
                 return `${value}:"${schemaObject['x-enum-comments'][enumKey]}"`;
             }).join(',')}}`;
         }
+        else if ((_a = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject['x-apifox']) === null || _a === void 0 ? void 0 : _a['enumDescriptions']) {
+            enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => {
+                const enumLabel = schemaObject['x-apifox']['enumDescriptions'][value];
+                return `${value}:"${enumLabel}"`;
+            }).join(',')}}`;
+        }
         else {
             if (!config_1.numberEnum.includes(schemaObject.type)) {
                 enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `${value}:"${value}"`).join(',')}}`;

package/dist/generator/util.d.ts

@@ -2,6 +2,7 @@ import { ArraySchemaObject, BinaryArraySchemaObject, ComponentsObject, ISchemaOb
 import { ITypeItem } from './type';
 export declare function stripDot(str: string): string;
 export declare function resolveTypeName(typeName: string): string;
+export declare function getRefName(refObject: ReferenceObject | string): string;
 export declare function getLastRefName(refPath?: string): string;
 export declare function getDefaultType(schemaObject?: ISchemaObject | string, namespace?: string, schemas?: ComponentsObject['schemas']): string;
 export declare function getDefaultFileTag(operationObject: OperationObject, apiPath: string): string[];
@@ -11,7 +12,7 @@ export declare function genDefaultFunctionName(path: string, pathBasePrefix: str
 export declare function getFinalFileName(s: string): string;
 export declare function replaceDot(s: string): string;
 export declare function resolveFunctionName(functionName: string, methodName: string): string;
-export declare function markAllowSchema(schemaStr: string, schemas: ComponentsObject['schemas']): void;
+export declare function markAllowedSchema(schemaStr: string, schemas: ComponentsObject['schemas']): void;
 export declare function isReferenceObject(schema: unknown): schema is ReferenceObject;
 export declare function isSchemaObject(schema: unknown): schema is SchemaObject;
 export declare function isNonArraySchemaObject(schema: unknown): schema is NonArraySchemaObject;

package/dist/generator/util.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stripDot = stripDot;
 exports.resolveTypeName = resolveTypeName;
+exports.getRefName = getRefName;
 exports.getLastRefName = getLastRefName;
 exports.getDefaultType = getDefaultType;
 exports.getDefaultFileTag = getDefaultFileTag;
@@ -11,7 +12,7 @@ exports.genDefaultFunctionName = genDefaultFunctionName;
 exports.getFinalFileName = getFinalFileName;
 exports.replaceDot = replaceDot;
 exports.resolveFunctionName = resolveFunctionName;
-exports.markAllowSchema = markAllowSchema;
+exports.markAllowedSchema = markAllowedSchema;
 exports.isReferenceObject = isReferenceObject;
 exports.isSchemaObject = isSchemaObject;
 exports.isNonArraySchemaObject = isNonArraySchemaObject;
@@ -285,13 +286,13 @@ function resolveFunctionName(functionName, methodName) {
     return functionName;
 }
 // 标记引用的 $ref 对应的schema
-function markAllowSchema(schemaStr, schemas) {
+function markAllowedSchema(schemaStr, schemas) {
     const refs = schemaStr === null || schemaStr === void 0 ? void 0 : schemaStr.match(/#\/components\/schemas\/([\w%«».-]+)/g);
     (0, lodash_1.forEach)(refs, (ref) => {
         const schema = schemas === null || schemas === void 0 ? void 0 : schemas[getLastRefName(ref)];
         if (schema && !schema.isAllowed) {
             schema.isAllowed = true;
-            markAllowSchema(JSON.stringify(schema), schemas);
+            markAllowedSchema(JSON.stringify(schema), schemas);
         }
     });
 }

package/dist/parser-mock/util.d.ts

@@ -44,6 +44,9 @@ export declare function inferSchema(thing: ParameterObject | SchemaObject | Refe
     'x-enum-comments'?: {
         [name: string]: string;
     };
+    'x-apifox'?: {
+        enumDescriptions: Record<string, string>;
+    };
     items: import("../type").ISchemaObject;
 } | {
     type: string;
@@ -86,5 +89,8 @@ export declare function inferSchema(thing: ParameterObject | SchemaObject | Refe
     'x-enum-comments'?: {
         [name: string]: string;
     };
+    'x-apifox'?: {
+        enumDescriptions: Record<string, string>;
+    };
 };
 export declare function getRandomInt(min: number, max: number): number;

package/dist/type.d.ts

@@ -14,6 +14,9 @@ type ICustomBaseSchemaObject = {
     'x-enum-comments'?: {
         [name: string]: string;
     };
+    'x-apifox'?: {
+        enumDescriptions: Record<string, string>;
+    };
 };
 export type ArraySchemaObject = Modify<OpenAPIV3.ArraySchemaObject, ICustomBaseSchemaObject & {
     items: ISchemaObject;
@@ -28,7 +31,9 @@ export type PathItemObject = Modify<OpenAPIV3.PathItemObject, {
 }>;
 export type OperationObject = Modify<OpenAPIV3.OperationObject, {
     parameters?: (ReferenceObject | ParameterObject)[];
-}>;
+}> & {
+    'x-run-in-apifox'?: string;
+};
 export type ComponentsObject = OpenAPIV3.ComponentsObject;
 export type OpenAPIObject = OpenAPIV3.Document;
 export type ParameterObject = Modify<OpenAPIV3.ParameterObject, {

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=9"
+  },
   "repository": {
     "type": "git",
     "url": "git+git@github.com:openapi-ui/openapi-ts-request.git"

package/templates/serviceController.njk

@@ -4,7 +4,7 @@ import * as {{ namespace }} from './{{ interfaceFileName }}';
 {{ requestImportStatement }}
 
 {% for api in list -%}
-/** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{api.method | upper}} {{ api.pathInComment | safe }} */
+/** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{ api.method | upper }} {{ api.pathInComment | safe }}{{ ' ' if api.apifoxRunLink else '' }}{{ api.apifoxRunLink | safe }} */
 export async function {{ api.functionName }}(
 {%- if api.params and api.hasParams %}
   // 叠加生成的Param类型 (非body参数openapi默认没有生成对象)