feat: add swagger doc

Author: adityak74

package-lock.json

@@ -17,7 +17,8 @@
     "inquirer": "^9.2.12",
     "joi": "^17.11.0",
     "playwright": "*",
-    "prettier": "^3.1.0"
+    "prettier": "^3.1.0",
+    "swagger-ui-express": "^5.0.0"
   },
   "devDependencies": {
     "@apify/tsconfig": "^0.1.0",
@@ -26,6 +27,8 @@
     "@types/express-fileupload": "^1.4.4",
     "@types/inquirer": "^9.0.7",
     "@types/node": "^20.0.0",
+    "@types/swagger-ui-express": "^4.1.6",
+    "swagger-autogen": "^2.23.7",
     "ts-node": "^10.8.0",
     "typescript": "^5.0.0"
   },

package.json

@@ -4,6 +4,9 @@ import { readFile } from 'fs/promises';
 import { crawl, write } from "./core.js";
 import { Config, ConfigSchema } from './config.js';
 import { configDotenv } from 'dotenv';
+import swaggerUi from 'swagger-ui-express';
+// @ts-ignore
+import swaggerDocument from '../swagger-output.json' assert { type: 'json' };
 
 configDotenv();
 
@@ -13,6 +16,7 @@ const hostname = process.env.API_HOST || 'localhost';
 
 app.use(cors());
 app.use(express.json());
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
 
 // Define a POST route to accept config and run the crawler
 app.post('/crawl', async (req, res) => {

src/server.ts

@@ -0,0 +1,14 @@
+import swaggerAutogen from 'swagger-autogen';
+
+const doc = {
+    info: {
+        title: 'GPT Crawler API',
+        description: 'GPT Crawler'
+    },
+    host: 'localhost:5000'
+};
+
+const outputFile = 'swagger-output.json';
+const routes = ['./src/server.ts'];
+
+swaggerAutogen()(outputFile, routes, doc);