feat: support tags

Author: wwayne

package.json

@@ -1,6 +1,6 @@
 {
   "name": "outdoc",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Auto-generate OpenAPI document for Node.js service from the local testing",
   "main": "lib/index.js",
   "bin": {

src/APICollector.ts

@@ -7,9 +7,11 @@ import type { API_URL } from './types/apiTypes';
 
 export default class APICollector {
   private items: Record<API_URL, OpenAPIV3_1.PathItemObject>;
+  private pathCount: Record<string, number>;
 
   constructor () {
     this.items = {};
+    this.pathCount = {};
   }
 
   /**
@@ -227,12 +229,24 @@ export default class APICollector {
     };
   }
 
+  private increasePathCountByUrl (url: string) {
+    const paths = url.split("/").slice(1, 3);
+    paths.forEach(path => {
+      this.pathCount[path] = this.pathCount[path] || 0;
+      this.pathCount[path]++;
+    });
+  }
+
   private insertNewAPIItem (
     url: API_URL,
     method: OpenAPIV3_1.HttpMethods,
     methodContent: OpenAPIV3_1.OperationObject,
     statusCode: number
   ): void {
+    if (!this.items[url]) {
+      this.increasePathCountByUrl(url);
+    }
+
     // If the url method doesnt exist
     if (!this.items[url] || !this.items[url][method]) {
       this.items[url] = this.items[url] || {};
@@ -273,8 +287,11 @@ export default class APICollector {
     const statusCode = serverResponse.statusCode;
     const url = this.extractURL(serverResponse);
     if (!url) throw new Error('No url found');
+
     const method = this.extractMethod(serverResponse);
-    const operationObj: OpenAPIV3_1.OperationObject = {};
+    const operationObj: OpenAPIV3_1.OperationObject = {
+      tags: undefined
+    };
     const methodsHasReqBody = ['post', 'put'];
 
     if (statusCode < 400) {
@@ -303,5 +320,9 @@ export default class APICollector {
   public getItems(): Record<API_URL, OpenAPIV3_1.PathItemObject> {
     return this.items;
   }
+
+  public getCountByPath(path: string): number {
+    return this.pathCount[path] || 0;
+  }
 }
 

src/APIGenerator.ts

@@ -16,6 +16,42 @@ type GenDocOpts = {
 const SUPPORTED_FORMAT = ['.json', '.yaml'];
 
 export default class APIGenerator {
+  private static getTagByUrl (
+    url: API_URL,
+    apiCollector: APICollector
+  ): string | undefined {
+    const paths = url.split("/").slice(1, 3);
+    const totalURLAmount = Object.keys(apiCollector.getItems()).length;
+    let tag;
+    let max = 0;
+    paths.forEach((path, index) => {
+      const count = apiCollector.getCountByPath(path);
+      if (index === 0) {
+        if (count <= 1 || count >= totalURLAmount -1) {
+          return;
+        } else {
+          tag = path.trim();
+          max = Infinity;
+        }
+      } else {
+        if (count > max && count > 1) {
+          tag = path.trim();
+          max = count;
+        }
+      }
+    });
+    return tag;
+  }
+
+  private static addTagToPathItem(
+    tag: string,
+    pathItem: OpenAPIV3_1.PathItemObject
+  ): void {
+    Object.keys(pathItem).forEach(key => {
+      pathItem[key as OpenAPIV3_1.HttpMethods]!.tags = [tag]
+    })
+  }
+
   public static async generate (
     apiCollector: APICollector,
     opts: GenDocOpts
@@ -25,6 +61,10 @@ export default class APIGenerator {
       .reduce((acc, cur) => {
         const key: API_URL = cur[0];
         const value: OpenAPIV3_1.PathItemObject = cur[1];
+        const tag = APIGenerator.getTagByUrl(key, apiCollector);
+        if (tag) {
+          APIGenerator.addTagToPathItem(tag, value);
+        }
         acc[key] = value;
         return acc;
       }, {} as Record<string, any>);

src/constants.ts

@@ -1,2 +1,2 @@
 export const PREFIX_RESPONSE_BODY_DATA = 'outdoc response body data -';
-export const PREFIX_SERVER_RESPONSE = 'outdoc server response -';
+export const PREFIX_SERVER_RESPONSE = 'outdoc server response -';