refactor(web page reader): change plugin name, add request params schema to the OpenAPI doc

Author: dat-devuap

src/api-docs/openAPIDocumentGenerator.ts

@@ -1,8 +1,8 @@
 import { OpenApiGeneratorV3, OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
 
-import { articleReaderRegistry } from '@/routes/articleReader/articleReaderRouter';
 import { healthCheckRegistry } from '@/routes/healthCheck/healthCheckRouter';
 import { powerpointGeneratorRegistry } from '@/routes/powerpointGenerator/powerpointGeneratorRouter';
+import { articleReaderRegistry } from '@/routes/webPageReader/webPageReaderRouter';
 import { wordGeneratorRegistry } from '@/routes/wordGenerator/wordGeneratorRouter';
 import { transcriptRegistry } from '@/routes/youtubeTranscript/transcriptRouter';
 

src/routes/articleReader/articleReaderModel.ts

@@ -0,0 +1,15 @@
+import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
+import { z } from 'zod';
+
+extendZodWithOpenApi(z);
+
+export type WebPageReaderResponse = z.infer<typeof WebPageReaderResponseSchema>;
+export const WebPageReaderResponseSchema = z.object({
+  title: z.string(),
+  content: z.string(),
+});
+
+export type WebPageReaderRequestParam = z.infer<typeof WebPageReaderRequestParamSchema>;
+export const WebPageReaderRequestParamSchema = z.object({
+  url: z.string().describe('The URL of the web page to retrieve content from'),
+});

src/routes/webPageReader/webPageReaderModel.ts

@@ -10,10 +10,10 @@ import { createApiResponse } from '@/api-docs/openAPIResponseBuilders';
 import { ResponseStatus, ServiceResponse } from '@/common/models/serviceResponse';
 import { handleServiceResponse } from '@/common/utils/httpHandlers';
 
-import { ArticleReaderSchema } from './articleReaderModel';
+import { WebPageReaderRequestParamSchema, WebPageReaderResponseSchema } from './webPageReaderModel';
 
 export const articleReaderRegistry = new OpenAPIRegistry();
-articleReaderRegistry.register('ArticleReader', ArticleReaderSchema);
+articleReaderRegistry.register('Web Page Reader', WebPageReaderResponseSchema);
 
 const removeUnwantedElements = (_cheerio: any) => {
   const elementsToRemove = [
@@ -59,14 +59,17 @@ const fetchAndCleanContent = async (url: string) => {
   return { title, content: article ? article.textContent : '' };
 };
 
-export const articleReaderRouter: Router = (() => {
+export const webPageReaderRouter: Router = (() => {
   const router = express.Router();
 
   articleReaderRegistry.registerPath({
     method: 'get',
-    path: '/content',
-    tags: ['Article Reader'],
-    responses: createApiResponse(ArticleReaderSchema, 'Success'),
+    path: '/web-page-reader/get-content',
+    tags: ['Web Page Reader'],
+    request: {
+      params: WebPageReaderRequestParamSchema,
+    },
+    responses: createApiResponse(WebPageReaderResponseSchema, 'Success'),
   });
 
   router.get('/', async (_req: Request, res: Response) => {

…tes/articleReader/articleReaderRouter.ts …tes/webPageReader/webPageReaderRouter.tssrc/routes/articleReader/articleReaderRouter.ts renamed to src/routes/webPageReader/webPageReaderRouter.ts src/routes/articleReader/articleReaderRouter.ts renamed to src/routes/webPageReader/webPageReaderRouter.ts

@@ -10,8 +10,8 @@ import rateLimiter from '@/common/middleware/rateLimiter';
 import requestLogger from '@/common/middleware/requestLogger';
 import { healthCheckRouter } from '@/routes/healthCheck/healthCheckRouter';
 
-import { articleReaderRouter } from './routes/articleReader/articleReaderRouter';
 import { powerpointGeneratorRouter } from './routes/powerpointGenerator/powerpointGeneratorRouter';
+import { webPageReaderRouter } from './routes/webPageReader/webPageReaderRouter';
 import { wordGeneratorRouter } from './routes/wordGenerator/wordGeneratorRouter';
 import { transcriptRouter } from './routes/youtubeTranscript/transcriptRouter';
 const logger = pino({ name: 'server start' });
@@ -37,7 +37,7 @@ app.use(requestLogger());
 app.use('/health-check', healthCheckRouter);
 app.use('/images', express.static('public/images'));
 app.use('/transcript', transcriptRouter);
-app.use('/get-content', articleReaderRouter);
+app.use('/web-page-reader', webPageReaderRouter);
 app.use('/powerpoint-generator', powerpointGeneratorRouter);
 app.use('/word-generator', wordGeneratorRouter);
 // Swagger UI