Skip to content

Latest commit

 

History

History
45 lines (40 loc) · 1.45 KB

README.md

File metadata and controls

45 lines (40 loc) · 1.45 KB
Raw

Node Express App for Pubcode API

This is a Node.js server application utilizing popular libraries and tools, including:

  1. Express: Framework for building web applications
  2. Morgan: Express middleware for logging
  3. NoCache: Express middleware for prevent client-side caching
  4. Helmet: Express middleware to secure an app using HTTP headers
  5. CORS: Express middleware to allows cross-origin resource sharing
  6. Body-Parser: Express middleware to parse incoming request for handling
  7. Mongoose: MongoDB object modeling tool
  8. Logger: Logs messages to the console
  9. Express-Rate-Limit: Express middleware for rate limiting by IP
  10. Dotenv: Zero-dependency module to loads environment variables (.env)

Sample .env

DB_HOST=<mongodb-host>
DB_PORT=<mongodb-port>
DB_NAME=<mongodb-database-name>
DB_USER=<mongodb-user>
DB_PWD=<mongodb-password>
API_KEY=<api-key>

graph LR
A[Client] --> B[Node Express App]
B --> C[pubcode Router]
C --> D[validate API Key Middleware]
D -->|X-API-KEY valid| E[bulkLoad Service]
D -->|X-API-KEY invalid| F[401 Unauthorized response]
E -->|Success| G[200 Success response]
E -->|Failure| H[500 Internal Server Error response with error log]
C --> I[readAll Service]
I -->|Success| J[200 Success response with data]
I -->|Failure| H
C --> K[findById Service]
K -->|Success| L[200 Success response with data]
K -->|Failure| H
C --> M[health Service]
M -->|Success| N[200 Success response with count]
M -->|Failure| H
Loading