openapi-ts-request 0.13.2 → 0.13.4

package/README.md

@@ -4,7 +4,14 @@
 
 <a href="https://github.com/openapi-ui/openapi-ts-request/blob/master/README-en_US.md">English</a> | 简体中文
 
-根据 [Swagger2/OpenAPI3/Apifox](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 TS 类型, 客户端请求函数, 模拟请求响应服务, 枚举, 类型字段翻译, JSON Schemas
+根据 [Swagger2/OpenAPI3/Apifox](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成:
+
+- TS 类型
+- 客户端请求函数
+- 模拟请求响应服务
+- 枚举和枚举翻译
+- 类型字段翻译
+- JSON Schemas
 
 文档：[使用手册](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
@@ -38,6 +45,8 @@ pnpm i openapi-ts-request -D
 import type { GenerateServiceProps } from 'openapi-ts-request';
 
 export default {
+  // schemaPath: './openapi.json', // 本地openapi文件
+  // serversPath: './src/apis', // 接口存放路径
   schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
 } as GenerateServiceProps;
 ```
@@ -61,12 +70,47 @@ export default [
 
 在 `package.json` 的 `script` 中添加命令: `"openapi": "openapi-ts",`
 
-生成结果：
+运行：
 
 ```bash
 npm run openapi
 ```
 
+生成的接口：
+
+```bash
+src/apis/index.ts #接口入口文件
+src/apis/types.ts #类型定义文件
+src/apis/pet.ts #接口文件
+```
+
+```typescript
+// src/apis/pet.ts
+
+/* eslint-disable */
+// @ts-ignore
+import request from 'axios';
+
+import * as API from './types';
+
+/** Update an existing pet PUT /pet */
+export async function updatePet(
+  body: API.Pet,
+  options?: { [key: string]: unknown }
+) {
+  return request<unknown>(`/pet`, {
+    method: 'PUT',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    data: body,
+    ...(options || {}),
+  });
+}
+
+// ... 其他接口
+```
+
 ### JS
 
 任意目录 `xxx/xxx` 新建 `openapi-ts-request.config.js`
@@ -82,7 +126,7 @@ generateService({
 
 在 `package.json` 的 `script` 中添加命令: `"openapi": "node xxx/xxx/openapi-ts-request.config.js"`
 
-生成结果：
+运行：
 
 ```bash
 npm run openapi
@@ -103,7 +147,7 @@ generateService({
 
 在 `package.json` 的 `script` 中添加命令: `"openapi": "ts-node xxx/xxx/openapi-ts-request.config.ts",`
 
-生成结果：
+运行：
 
 ```bash
 npm run openapi
@@ -160,7 +204,7 @@ $ openapi --help
     -h, --help                         display help for command
 ```
 
-生成结果：
+运行：
 
 ```bash
 openapi --i ./spec.json --o ./apis
@@ -171,7 +215,7 @@ openapi --i ./spec.json --o ./apis
 | 属性 | 必填 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
-| serversPath | 否 | string | './src/apis' | 生成结果的文件夹路径 |
+| serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
 | enableLogging | 否 | boolean | false | 是否开启日志 |
 | priorityRule | 否 | string | 'include' | 模式规则，可选include/exclude/both |

package/dist/generator/serviceGenarator.js

@@ -722,6 +722,13 @@ class ServiceGenerator {
                 return `${value}:"${enumLabel}"`;
             }).join(',')}}`;
         }
+        else if (schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject['x-apifox-enum']) {
+            enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => {
+                var _a;
+                const enumLabel = (_a = (0, lodash_1.find)(schemaObject['x-apifox-enum'], (item) => item.value === value)) === null || _a === void 0 ? void 0 : _a.description;
+                return `${value}:"${enumLabel}"`;
+            }).join(',')}}`;
+        }
         else {
             if (config_1.numberEnum.includes(schemaObject.type) || (0, util_1.isAllNumber)(enumArray)) {
                 enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `"NUMBER_${value}":${Number(value)}`).join(',')}}`;

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

@@ -47,6 +47,11 @@ export declare function inferSchema(thing: ParameterObject | SchemaObject | Refe
     'x-apifox'?: {
         enumDescriptions: Record<string, string>;
     };
+    'x-apifox-enum'?: {
+        value: string;
+        name: string;
+        description: string;
+    }[];
     items: import("../type").ISchemaObject;
 } | {
     type: string;
@@ -92,5 +97,10 @@ export declare function inferSchema(thing: ParameterObject | SchemaObject | Refe
     'x-apifox'?: {
         enumDescriptions: Record<string, string>;
     };
+    'x-apifox-enum'?: {
+        value: string;
+        name: string;
+        description: string;
+    }[];
 };
 export declare function getRandomInt(min: number, max: number): number;

package/dist/type.d.ts

@@ -17,6 +17,11 @@ type ICustomBaseSchemaObject = {
     'x-apifox'?: {
         enumDescriptions: Record<string, string>;
     };
+    'x-apifox-enum'?: {
+        value: string;
+        name: string;
+        description: string;
+    }[];
 };
 export type ArraySchemaObject = Modify<OpenAPIV3.ArraySchemaObject, ICustomBaseSchemaObject & {
     items: ISchemaObject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.13.2",
+  "version": "0.13.4",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",