Merge pull request #4 from muneebhashone/openapi-integration

Openapi integration

Author: muneebhashone

README.md

@@ -24,14 +24,12 @@ Before you get started, make sure you have the following installed on your machi
      ```sh
      docker compose up -d
      ```
-
 2. **Install Dependencies**:
 
    - Use pnpm to install all the necessary dependencies:
      ```sh
      pnpm i
      ```
-
 3. **Configure Environment Variables**:
 
    - Create a `.env` file in the root directory.
@@ -83,3 +81,7 @@ Before you get started, make sure you have the following installed on your machi
 ## Contributions
 
 Feel free to contribute to this project by submitting issues or pull requests. Let's build something amazing together!
+
+## **License**
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

build.ts

@@ -9,4 +9,5 @@ export default defineConfig({
   minify: true,
   platform: 'node',
   tsconfig: 'tsconfig.json',
+  keepNames: true,
 });

docker-compose.yml

@@ -10,7 +10,7 @@ services:
       MONGO_INITDB_ROOT_USERNAME: root
       MONGO_INITDB_ROOT_PASSWORD: example
     volumes:
-      - mongodb_city_link:/data/db
+      - mongodb_typescript_backend_toolkit:/data/db
 
   redis:
     image: redis:latest
@@ -20,6 +20,6 @@ services:
       - redis:/data
 
 volumes:
-  mongodb_city_link:
+  mongodb_typescript_backend_toolkit:
     external: true
   redis:

documentation/Insomnia_2024-08-11.json

@@ -1,7 +1,7 @@
 module.exports = {
   apps: [
     {
-      name: 'city-link-api',
+      name: 'typescript-backend-toolkit',
       script: './dist/main.js',
     },
   ],

ecosystem.config.js

@@ -0,0 +1,58 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: My API
+  description: This is the API
+servers:
+  - url: v1
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+  schemas:
+    UserId:
+      type: string
+      example: "1212121"
+    User:
+      type: object
+      properties:
+        id:
+          type: string
+          example: "1212121"
+        name:
+          type: string
+          example: John Doe
+        age:
+          type: number
+          example: 42
+      required:
+        - id
+        - name
+        - age
+  parameters:
+    UserId:
+      schema:
+        $ref: "#/components/schemas/UserId"
+      required: true
+      name: id
+      in: path
+paths:
+  /users/{id}:
+    get:
+      description: Get user data by its id
+      summary: Get a single user
+      security:
+        - bearerAuth: []
+      parameters:
+        - $ref: "#/components/parameters/UserId"
+      responses:
+        "200":
+          description: Object with user data.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/User"
+        "204":
+          description: No content - successful operation

openapi-docs.yml

@@ -1,5 +1,5 @@
 {
-  "name": "shipment-tracking-queue",
+  "name": "typescript-backend-toolkit",
   "version": "1.0.0",
   "description": "",
   "main": "dist/main.js",
@@ -30,6 +30,7 @@
     "@types/node": "^18.11.18",
     "@types/nodemailer": "^6.4.8",
     "@types/passport": "^1.0.11",
+    "@types/swagger-ui-express": "^4.1.6",
     "@types/validator": "^13.7.17",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^7.11.0",
@@ -47,6 +48,7 @@
     "typescript-eslint": "^7.11.0"
   },
   "dependencies": {
+    "@asteasolutions/zod-to-openapi": "^7.1.1",
     "@aws-sdk/client-s3": "^3.606.0",
     "@bull-board/api": "^5.19.0",
     "@bull-board/express": "^5.16.0",
@@ -81,14 +83,17 @@
     "multer-s3": "^3.0.1",
     "nanoid": "^3.3.7",
     "nodemailer": "^6.9.13",
+    "openapi3-ts": "^4.3.3",
     "passport": "^0.7.0",
     "passport-jwt": "^4.0.1",
     "pino": "^9.1.0",
     "pino-http": "^10.1.0",
     "pino-pretty": "^11.1.0",
     "redis": "^4.6.11",
     "socket.io": "^4.7.5",
+    "swagger-ui-express": "^5.0.1",
     "validator": "^13.12.0",
+    "yaml": "^2.5.0",
     "zod": "^3.21.4"
   },
   "author": "",