Merge pull request #13 from erik1110/feature/api

Feature/api
erik1110 · Jan 17, 2024 · 4b0d660 · 4b0d660
2 parents 78976e7 + 02b1917
commit 4b0d660
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/src/main.ts b/src/main.ts
@@ -11,7 +11,15 @@ async function bootstrap() {
   app.useGlobalFilters(new ErrorHandlerFilter());
   const config = new DocumentBuilder()
     .setTitle('Hotel Reservation Backend')
-    .setDescription('This is my swagger document.')
+    .setDescription(`Building a Hotel Reservation API on the Backend with TypeScript.\n\nNote: After successful login, please click on "Authorize" and enter your access token.\n\nExample Code :
+
+    fetch('/api/v1/home/news', { method: 'GET' })
+        .then(response => response.json())
+        .then(res => {
+            // { status: 'true', result: [{...}] }
+            console.log(res);
+        });
+    `)
     .setVersion('1.0')
     .addServer(`http://localhost:${process.env.PORT}`, 'Local Environment')
     .addServer(process.env.PRODUCTION_URL, 'Production') // HTTPS scheme