openapi-ts-request 0.2.0 → 0.3.0

package/README.md

@@ -4,15 +4,15 @@
 [![npm (scoped)](https://img.shields.io/npm/v/openapi-ts-request)](https://www.npmjs.com/package/openapi-ts-request)
 ![GitHub tag](https://img.shields.io/github/v/tag/openapi-ui/openapi-ts-request?include_prereleases)
 
-根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 ts 类型、request client 请求代码、request mock 服务、枚举和 type 字段翻译
+根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 ts 类型, request client 请求代码, request mock 服务, 枚举, type 字段翻译, JSON Schemas
 
 ## Features
 
-* supports Swagger2.0/OpenAPI 3.0,3.1 specifications
-* generate TypeScript Interfaces, Reuquest clients, Request Mock Service, Enum, Display Type Field Label
-* supports Custom Request Function, Fetch、Axios、Uniapp-Request、Node.js、XHR client available
-* supports filter specifications by tags
-* supports JSON specifications
+* support Swagger2.0/OpenAPI 3.0,3.1 specification
+* generate TypeScript interface, reuquest client, request mock service, enum, type field label, JSON Schemas
+* support custom request function, Fetch、Axios、Uniapp-Request、Node.js、XHR client available
+* support filter specification by tags
+* support JSON specification
 
 ## Usage
 
@@ -109,6 +109,7 @@ npm run openapi
 | requestImportStatement  | 否 | 自定义请求方法表达式，例如：'@/request' | string | - |
 | apiPrefix  | 否 | api 的前缀，例如：'api'(动态变量), 指定字符串("'api'") | string | - |
 | isDisplayTypeLabel | 否 | 是否生成 type 对应的label | boolean | false |
+| isGenJsonSchemas | 否 | 是否生成 JSON Schemas | boolean | false |
 | dataFields | 否 | 定义 response 中数据字段类型 | string[] | - |
 | mockFolder  | 否 | mock目录 | string | './mocks' |
 | nullable | 否 | 使用null代替可选 | boolean | false |
@@ -126,6 +127,15 @@ npm run openapi
 | customType | (<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string) => string,<br>) => string  | 自定义获取类型 <br> *返回非字符串将使用默认方法获取type* |
 | customFileNames |  (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[]   | 自定义生成文件名，可返回多个，表示生成多个文件. <br> *返回为空，则使用默认的获取方法获取* |
 
+## JSON Schemas
+
+- 默认生成 [components.schemas](https://spec.openapis.org/oas/latest.html#components-object) 下面的 JSON Schemas, [paths](https://spec.openapis.org/oas/latest.html#paths-object) 对应的 JSON Schemas 目前需自行解析
+- 提供一个解析 schema 的函数用于将 `$ref`, `$allOf` 的引用填充到 `当前schema`
+
+```ts
+export declare function patchSchema<T extends object>(schema: ISchemaObject, schemas: ComponentsObject["schemas"]): T;
+```
+
 ## Mock
 
 目前使用 [mockjs](http://mockjs.com) 生成 mock 数据，mocks 文件启动需要借助 [@umijs/server](https://umijs.org/docs/guides/mock)，后面会寻找其他方案以达到更好的 mock 体验
@@ -134,16 +144,4 @@ npm run openapi
 
 - [openapi2typescript](https://github.com/chenshuai2144/openapi2typescript)
 
-ps：由于 openapi2typescript 仓库作者不怎么维护这个工具，不会主动增加功能，有些激进的pr也不再合并，为了更大的自主性，也为了方便自己更好的维护此工具，所以基于此仓库重构代码并添加了很多功能（后续还会加一些对部分场景有用的功能），并附上了注释方便大家感兴趣的一起参与（都是为开源做一点贡献，应该不会被诟病吧😭😭😭），例如：
-* 支持 tags 筛选api（对 apifox 工具管理接口非常有用）
-* 支持枚举和枚举翻译
-* 改善 interface 对枚举的引用方式，对 ast 提示更友好
-* 改写 type 文件组织方式，引用 type 的提示更友好
-* 解决 type 重名问题
-* 支持配置文件方式使用，避免强制依赖 ts-node
-* 支持自定义 prettier 配置，将作用于生成后的代码
-* 替换 openapi 规范定义包：openapi3-ts => openapi-types
-* 添加 eslint、tslint 规则，优化代码
-* 添加 husky、lint-staged、commitlint 等等工程化工具
-* 优化对外提供的参数
-* 优化 npm 包依赖
+ps：由于 openapi2typescript 仓库作者不怎么维护这个工具，不会主动增加功能，有些激进的pr也不再合并，为了更大的自主性，也为了方便自己更好的维护此工具，所以基于此仓库重构代码并添加了很多功能，感谢原作者！

package/dist/generator/config.d.ts

@@ -4,12 +4,14 @@ export declare const serviceEntryFileName = "index";
 export declare const interfaceFileName = "types";
 export declare const displayEnumLabelFileName = "displayEnumLabel";
 export declare const displayTypeLabelFileName = "displayTypeLabel";
+export declare const schemaFileName = "schema";
 export declare enum TypescriptFileType {
     interface = "interface",
     serviceController = "serviceController",
     serviceIndex = "serviceIndex",
     displayEnumLabel = "displayEnumLabel",
-    displayTypeLabel = "displayTypeLabel"
+    displayTypeLabel = "displayTypeLabel",
+    schema = "schema"
 }
 export declare const DEFAULT_SCHEMA: SchemaObject;
 export declare const DEFAULT_PATH_PARAM: ParameterObject & Dictionary<unknown>;

package/dist/generator/config.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lineBreakReg = exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.displayTypeLabelFileName = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
+exports.lineBreakReg = exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.schemaFileName = exports.displayTypeLabelFileName = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
 exports.serviceEntryFileName = 'index';
 exports.interfaceFileName = 'types';
 exports.displayEnumLabelFileName = 'displayEnumLabel';
 exports.displayTypeLabelFileName = 'displayTypeLabel';
+exports.schemaFileName = 'schema';
 var TypescriptFileType;
 (function (TypescriptFileType) {
     TypescriptFileType["interface"] = "interface";
@@ -12,6 +13,7 @@ var TypescriptFileType;
     TypescriptFileType["serviceIndex"] = "serviceIndex";
     TypescriptFileType["displayEnumLabel"] = "displayEnumLabel";
     TypescriptFileType["displayTypeLabel"] = "displayTypeLabel";
+    TypescriptFileType["schema"] = "schema";
 })(TypescriptFileType || (exports.TypescriptFileType = TypescriptFileType = {}));
 exports.DEFAULT_SCHEMA = {
     type: 'object',

package/dist/generator/patchSchema.d.ts

@@ -0,0 +1,2 @@
+import { ComponentsObject, ISchemaObject } from '../type';
+export declare function patchSchema<T extends object>(schema: ISchemaObject, schemas: ComponentsObject['schemas']): T;

package/dist/generator/patchSchema.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patchSchema = void 0;
+const lodash_1 = require("lodash");
+const util_1 = require("./util");
+function patchSchema(schema, schemas) {
+    if ((0, lodash_1.isEmpty)(schema)) {
+        return {};
+    }
+    if ((0, lodash_1.has)(schema, 'allOf')) {
+        return (0, lodash_1.reduce)(schema.allOf, (last, s) => {
+            const f = Object.assign({}, (last || {}));
+            const next = patchSchema(s, schemas);
+            (0, lodash_1.forEach)(next, (v, k) => {
+                switch (k) {
+                    case 'properties':
+                        f[k] = Object.assign(Object.assign({}, f[k]), (v || {}));
+                        break;
+                    case 'required':
+                        f[k] = (0, lodash_1.uniq)((f[k] || []).concat(v));
+                        break;
+                    default: {
+                        f[k] = v;
+                    }
+                }
+            });
+            return f;
+        }, (0, lodash_1.omit)(schema, 'allOf'));
+    }
+    if ((0, util_1.isReferenceObject)(schema) &&
+        (0, lodash_1.startsWith)(schema.$ref, '#/components/schemas/')) {
+        const refId = (0, lodash_1.replace)(schema.$ref, '#/components/schemas/', '') ||
+            schema['x-id'];
+        if (schemas[refId]) {
+            return Object.assign(Object.assign(Object.assign({}, schema), patchSchema(schemas[refId], schemas)), { 'x-id': refId, $ref: undefined });
+        }
+    }
+    if ((0, util_1.isNonArraySchemaObject)(schema)) {
+        const patchedProperties = (0, lodash_1.mapValues)(schema.properties, (propSchema) => patchSchema(propSchema, schemas));
+        if ((0, lodash_1.isObject)(schema.additionalProperties)) {
+            const additionalProperties = patchSchema(schema.additionalProperties, schemas);
+            return Object.assign(Object.assign({}, schema), { additionalProperties });
+        }
+        return Object.assign(Object.assign({}, schema), { properties: patchedProperties });
+    }
+    if ((0, util_1.isArraySchemaObject)(schema)) {
+        return Object.assign(Object.assign({}, schema), { items: patchSchema(schema.items, schemas) });
+    }
+    return schema;
+}
+exports.patchSchema = patchSchema;

package/dist/generator/serviceGenarator.d.ts

@@ -1,12 +1,13 @@
 import type { GenerateServiceProps } from '../index';
 import { OpenAPIObject } from '../type';
-import { ControllerType, TagAPIDataType } from './type';
+import { ControllerType, ISchemaItem, TagAPIDataType } from './type';
 export default class ServiceGenerator {
     protected apiData: TagAPIDataType;
     protected classNameList: ControllerType[];
     protected finalPath: string;
     protected config: GenerateServiceProps;
     protected openAPIData: OpenAPIObject;
+    protected schemaList: ISchemaItem[];
     constructor(config: GenerateServiceProps, openAPIData: OpenAPIObject);
     genFile(): void;
     private getInterfaceTPConfigs;

package/dist/generator/serviceGenarator.js

@@ -11,12 +11,14 @@ const log_1 = tslib_1.__importDefault(require("../log"));
 const type_1 = require("../type");
 const config_1 = require("./config");
 const file_1 = require("./file");
+const patchSchema_1 = require("./patchSchema");
 const util_1 = require("./util");
 class ServiceGenerator {
     constructor(config, openAPIData) {
         var _a, _b;
         this.apiData = {};
         this.classNameList = [];
+        this.schemaList = [];
         this.finalPath = '';
         this.config = Object.assign({ templatesFolder: (0, path_1.join)(__dirname, '../../', 'templates') }, config);
         const hookCustomFileNames = ((_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customFileNames) || util_1.getDefaultFileTag;
@@ -104,7 +106,16 @@ class ServiceGenerator {
             list: this.classNameList,
             namespace: this.config.namespace,
             interfaceFileName: config_1.interfaceFileName,
+            schemaFileName: config_1.schemaFileName,
         });
+        if (this.config.isGenJsonSchemas) {
+            // 处理重复的 schemaName
+            (0, util_1.handleDuplicateTypeNames)(this.schemaList);
+            // 生成 schema 文件
+            this.genFileFromTemplate(`${config_1.schemaFileName}.ts`, config_1.TypescriptFileType.schema, {
+                list: this.schemaList,
+            });
+        }
         // 打印日志
         (0, log_1.default)('✅ 成功生成 api 文件');
     }
@@ -163,6 +174,7 @@ class ServiceGenerator {
             });
         });
         (0, lodash_1.keys)(schemas).forEach((schemaKey) => {
+            var _a;
             const schema = schemas[schemaKey];
             const result = this.resolveObject(schema);
             const getDefinesType = () => {
@@ -191,6 +203,7 @@ class ServiceGenerator {
                     }
                 });
             }
+            // 判断哪些 schema 需要添加进 type, schemas 渲染数组
             if ((0, lodash_1.isEmpty)(this.config.allowedTags) ||
                 schema.isAllowed) {
                 const isEnum = result.isEnum;
@@ -205,6 +218,12 @@ class ServiceGenerator {
                         : '',
                     enumLabelType: isEnum ? result.enumLabelType : '',
                 });
+                if (this.config.isGenJsonSchemas) {
+                    this.schemaList.push({
+                        typeName: `$${(0, util_1.resolveTypeName)(schemaKey)}`,
+                        type: JSON.stringify((0, patchSchema_1.patchSchema)(schema, (_a = this.openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas)),
+                    });
+                }
             }
         });
         return lastTypes === null || lastTypes === void 0 ? void 0 : lastTypes.sort((a, b) => a.typeName.localeCompare(b.typeName)); // typeName排序

package/dist/generator/type.d.ts

@@ -32,3 +32,7 @@ export type ICustomParameterObject = ParameterObject & {
     isObject: boolean;
     type: string;
 };
+export interface ISchemaItem {
+    typeName: string;
+    type: string;
+}

package/dist/generator/util.d.ts

@@ -4,7 +4,7 @@ export declare function stripDot(str: string): string;
 export declare function resolveTypeName(typeName: string): string;
 export declare function getDefaultType(schemaObject?: ISchemaObject | string, namespace?: string, schemas?: ComponentsObject['schemas']): string;
 export declare function getDefaultFileTag(operationObject: OperationObject, apiPath: string): string[];
-export declare function handleDuplicateTypeNames(interfaceTPConfigs: ITypeItem[]): void;
+export declare function handleDuplicateTypeNames(interfaceTPConfigs: Array<Pick<ITypeItem, 'typeName' | 'displayLabelFuncName'>>): void;
 export declare function getBasePrefix(paths: string[]): string;
 export declare function genDefaultFunctionName(path: string, pathBasePrefix: string): string;
 export declare function getFinalFileName(s: string): string;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { APIDataType } from './generator/type';
 import { ComponentsObject, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
+export * from './generator/patchSchema';
 export type GenerateServiceProps = {
     /**
      * Swagger 2.0 或 OpenAPI 3.0 的地址
@@ -42,6 +43,10 @@ export type GenerateServiceProps = {
      * 是否生成 type 对应的label, 默认: false
      */
     isDisplayTypeLabel?: boolean;
+    /**
+     * 是否生成 JSON Schemas, 默认: false
+     */
+    isGenJsonSchemas?: boolean;
     /**
      * response中数据字段
      * example: ['result', 'res']

package/dist/index.js

@@ -6,6 +6,7 @@ const lodash_1 = require("lodash");
 const mockGenarator_1 = require("./generator/mockGenarator");
 const serviceGenarator_1 = tslib_1.__importDefault(require("./generator/serviceGenarator"));
 const util_1 = require("./util");
+tslib_1.__exportStar(require("./generator/patchSchema"), exports);
 function generateService(_a) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         var { requestLibPath, schemaPath, mockFolder, allowedTags } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "allowedTags"]);
@@ -17,7 +18,7 @@ function generateService(_a) {
             return;
         }
         const requestImportStatement = (0, util_1.getImportStatement)(requestLibPath);
-        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, isDisplayTypeLabel: false, allowedTags: allowedTags
+        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, isDisplayTypeLabel: false, isGenJsonSchemas: false, allowedTags: allowedTags
                 ? (0, lodash_1.map)(allowedTags, (item) => item.toLowerCase())
                 : null }, rest), openAPI);
         serviceGenerator.genFile();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.2.0",
-  "description": "Swagger2/OpenAPI3 to TypeScript, Request Client, Request Mock Service, Enum, Display Field Label",
+  "version": "0.3.0",
+  "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "repository": {
     "type": "git",
     "url": "git+git@github.com:openapi-ui/openapi-ts-request.git"
@@ -32,7 +32,8 @@
     "reserved-words": "^0.1.2",
     "rimraf": "^5.0.7",
     "swagger2openapi": "^7.0.8",
-    "tiny-pinyin": "^1.3.2"
+    "tiny-pinyin": "^1.3.2",
+    "tslib": "^2.6.3"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
@@ -54,7 +55,6 @@
     "lint-staged": "^15.2.5",
     "np": "^10.0.6",
     "openapi-types": "^12.1.3",
-    "tslib": "^2.6.3",
     "typescript": "5.4.5"
   },
   "keywords": [
@@ -65,7 +65,8 @@
     "openapi to request client",
     "openapi to axios client",
     "openapi to fetch client",
-    "openapi to uni.request client"
+    "openapi to uni request client",
+    "openapi to JSON Schemas"
   ],
   "scripts": {
     "start": "tsc -w",

package/templates/interface.njk

@@ -1,54 +1,56 @@
 /* eslint-disable */
 // @ts-ignore
-{% for type in list -%}
-  {%- if type.props.length %}
-    export type {{ type.typeName | safe }} =
-    {%- for prop in type.props %}
-      {%- if prop.length > 1 %}
-        {
-      {%- endif %}
-      {%- if prop.length == 1 %}
-        {%- if not prop[0].$ref or prop[0].name %}
-        {
+{%- if list.length > 0 %}
+  {% for type in list -%}
+    {%- if type.props.length %}
+      export type {{ type.typeName | safe }} =
+      {%- for prop in type.props %}
+        {%- if prop.length > 1 %}
+          {
         {%- endif %}
-      {%- endif %}
-        {%- for p in prop %}
-          {%- if p.desc %}
-            /** {{ p.desc }} */
+        {%- if prop.length == 1 %}
+          {%- if not prop[0].$ref or prop[0].name %}
+          {
           {%- endif %}
-          {%- if p["$ref"] and not p.name %}
-            // {{ p.$ref }}
-            {{ p.type | safe }}
-          {%- else %}
-            {%- if nullable %}
-              '{{ p.name }}': {{ p.type | safe }}{{'' if p.required else '| null'}};
+        {%- endif %}
+          {%- for p in prop %}
+            {%- if p.desc %}
+              /** {{ p.desc }} */
+            {%- endif %}
+            {%- if p["$ref"] and not p.name %}
+              // {{ p.$ref }}
+              {{ p.type | safe }}
             {%- else %}
-              '{{ p.name }}'{{ '' if p.required else '?' }}: {{ p.type | safe }};
+              {%- if nullable %}
+                '{{ p.name }}': {{ p.type | safe }}{{'' if p.required else '| null'}};
+              {%- else %}
+                '{{ p.name }}'{{ '' if p.required else '?' }}: {{ p.type | safe }};
+              {%- endif %}
             {%- endif %}
+          {%- endfor %}
+        {%- if prop.length > 1 %}
+          }
+        {%- endif %}
+        {%- if prop.length == 1 %}
+          {%- if not prop[0].$ref or prop[0].name %}
+          }
           {%- endif %}
-        {%- endfor %}
-      {%- if prop.length > 1 %}
-        }
-      {%- endif %}
-      {%- if prop.length == 1 %}
-        {%- if not prop[0].$ref or prop[0].name %}
-        }
         {%- endif %}
-      {%- endif %}
-      {%- if prop.length == 0 %}
-        {}
-      {%- endif %}
-      {{ '' if loop.last === true else ' & '  }}
-    {%- endfor %}
-  {%- else %}
-    {%- if type.isEnum  %}
-      export enum {{ type.typeName | safe }} {{ type.type }};
-
-      export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}
+        {%- if prop.length == 0 %}
+          {}
+        {%- endif %}
+        {{ '' if loop.last === true else ' & '  }}
+      {%- endfor %}
     {%- else %}
-      export type {{ type.typeName | safe }} = {{ type.type }};
-    {%- endif %}
-  {%- endif %}
-{% endfor %}
+      {%- if type.isEnum  %}
+        export enum {{ type.typeName | safe }} {{ type.type }};
 
-export default {}
+        export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}
+      {%- else %}
+        export type {{ type.typeName | safe }} = {{ type.type }};
+      {%- endif %}
+    {%- endif %}
+  {% endfor %}
+{%- else %}
+  export default {}
+{%- endif %}

package/templates/schema.njk

@@ -0,0 +1,8 @@
+{%- if list.length > 0 %}
+  {% for type in list -%}
+  export const {{ type.typeName }} = {{ type.type }}
+
+  {% endfor -%}
+{%- else %}
+  export default {}
+{%- endif %}

package/templates/serviceIndex.njk

@@ -1,11 +1,13 @@
 /* eslint-disable */
 // @ts-ignore
 import * as {{ namespace }} from './{{ interfaceFileName }}';
+import * as schemas from './{{ schemaFileName }}';
 {% for api in list -%}
 import * as {{ api.controllerName }} from './{{ api.fileName }}';
 {% endfor -%}
 
 export default {
+  schemas,
   {{ namespace }},
   {% for api in list -%}
   {{ api.controllerName }},