feat: support parse swagger.yml/openapi.yml

Author: rookie-luochao

.changeset/heavy-rivers-grin.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': minor
+---
+
+feat: support parse swagger.yml/openapi.yml

README-en_US.md

@@ -13,7 +13,7 @@ Generate TS interfaces, request client, request mock service, enum, type field l
 - support work with npx, CLI, Nodejs
 - support custom request function, Fetch、Axios、[UniApp-request](https://github.com/openapi-ui/openapi-ts-request/issues/46)、Node.js、XHR client available
 - support filter generate result by tags
-- support JSON specification
+- support JSON/YAML specification
 
 ## Usage
 

README.md

@@ -13,7 +13,7 @@
 - 支持通过 npx、CLI、Nodejs 的方式使用
 - 支持自定义请求工具函数, 支持 Fetch、Axios、[UniApp-Request](https://github.com/openapi-ui/openapi-ts-request/issues/46)、Node.js、XHR 客户端
 - 支持通过 tags 过滤生成结果
-- 支持 JSON 定义文件
+- 支持 JSON/YAML 定义文件
 
 ## 使用
 

package.json

@@ -40,6 +40,7 @@
     "cosmiconfig": "^9.0.0",
     "cosmiconfig-typescript-loader": "^5.0.0",
     "glob": "^10.4.2",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.17",
     "mockjs": "^1.1.0",
@@ -56,6 +57,7 @@
     "@changesets/cli": "^2.27.6",
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.2.2",
+    "@types/js-yaml": "^4.0.9",
     "@types/lodash": "^4.17.5",
     "@types/memoizee": "^0.4.11",
     "@types/mockjs": "^1.0.10",

pnpm-lock.yaml

@@ -1,7 +1,10 @@
 import axios from 'axios';
 import http from 'http';
 import https from 'https';
-import { OpenAPI, OpenAPIV2 } from 'openapi-types';
+import * as yaml from 'js-yaml';
+import { isObject } from 'lodash';
+import { readFileSync } from 'node:fs';
+import { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';
 import converter from 'swagger2openapi';
 
 import log from './log';
@@ -44,17 +47,23 @@ async function getSchema(schemaPath: string) {
     delete require.cache[schemaPath];
   }
 
-  const schema = (await require(schemaPath)) as OpenAPI.Document;
+  let schema: string | OpenAPI.Document = '';
+
+  try {
+    schema = (await require(schemaPath)) as OpenAPI.Document;
+  } catch {
+    try {
+      schema = readFileSync(schemaPath, 'utf8');
+    } catch (error) {
+      console.error('Error reading schema file:', error);
+    }
+  }
 
   return schema;
 }
 
 function converterSwaggerToOpenApi(swagger: OpenAPI.Document) {
-  if (!(swagger as OpenAPIV2.Document).swagger) {
-    return swagger;
-  }
-
-  return new Promise((resolve, reject) => {
+  return new Promise<OpenAPIV3.Document>((resolve, reject) => {
     const convertOptions = {
       patch: true,
       warnOnly: true,
@@ -83,10 +92,46 @@ export const getOpenAPIConfig = async (schemaPath: string) => {
   const schema = await getSchema(schemaPath);
 
   if (!schema) {
-    return null;
+    return;
   }
 
-  const openAPI = await converterSwaggerToOpenApi(schema);
+  const openAPI = await parseSwaggerOrOpenapi(schema);
 
   return openAPI;
 };
+
+export async function parseSwaggerOrOpenapi(
+  content: string | OpenAPI.Document
+) {
+  let openapi = {} as OpenAPI.Document;
+
+  if (isObject(content)) {
+    openapi = content;
+
+    // if is swagger2.0 json, covert swagger2.0 to openapi3.0
+    if ((openapi as OpenAPIV2.Document).swagger) {
+      openapi = await converterSwaggerToOpenApi(openapi);
+    }
+  } else {
+    if (isJSONString(content)) {
+      openapi = JSON.parse(content) as OpenAPI.Document;
+    } else {
+      openapi = yaml.load(content) as OpenAPI.Document;
+    }
+
+    if ((openapi as OpenAPIV2.Document).swagger) {
+      openapi = await converterSwaggerToOpenApi(openapi);
+    }
+  }
+
+  return openapi;
+}
+
+function isJSONString(str: string) {
+  try {
+    JSON.parse(str);
+    return true;
+  } catch (error) {
+    return false;
+  }
+}