Multi-Tenant REST API Platform

A multi-tenant REST API platform with an admin portal for managing applications and API keys.

Features

• Application registration with unique API keys
• Admin portal for application management
• Secure API endpoints with API key authentication
• Application domain description endpoint
• Dashboard for data insights
• Multi-tenant support
• Swagger API documentation
• Winston logging
• Rate limiting
• Security features (JWT authentication, Helmet, CORS)

Prerequisites

• Node.js (v14 or higher)
• MongoDB
• Angular CLI

Project Structure

The project is organized into three main components:

• application-api/: Backend REST API service (Express.js)
• application-api-nestjs/: Backend REST API service (NestJS)
• admin-portal/: Frontend admin interface

Installation

Backend Setup (Express.js)

1. Navigate to the backend directory:

   cd application-api

2. Install backend dependencies:

   npm install

3. Set up environment variables:

   • Copy .env.example to .env
   • Update the values in .env

4. Start the backend server:

   npm start

Backend Setup (NestJS)

1. Navigate to the NestJS backend directory:

   cd application-api-nestjs

2. Install backend dependencies:

   npm install

3. Set up environment variables:

   • Copy .env.example to .env
   • Update the values in .env:

   PORT=3000
   MONGODB_URI=mongodb://localhost:27017/multi-tenant-api
   JWT_SECRET=your-secret-key-here
   FRONTEND_URL=http://localhost:4200
   

4. Start the backend server:

   # Development
   npm run start:dev
   
   # Production
   npm run build
   npm run start:prod

5. Access the Swagger API documentation at:

   http://localhost:3000/api-docs
   

6. Run tests:

   # Unit tests
   npm run test
   
   # e2e tests
   npm run test:e2e
   
   # Test coverage
   npm run test:cov

The NestJS API will be available at http://localhost:3000 and the Swagger documentation at http://localhost:3000/api.

Frontend Setup (Angular Admin Portal)

Prerequisites

• Node.js (v16+)
• Angular CLI (v17+)

Installation

1. Navigate to admin-portal directory

cd admin-portal

2. Install dependencies

npm install

3. Start Development Server

ng serve

4. Build for Production

ng build --configuration=production

Environment Configuration

• Update src/environments/environment.ts with your backend API URL
• Ensure CORS is configured in backend for frontend access

API Endpoints

Admin Endpoints (Protected)

• POST /api/auth/# - Admin login
• POST /api/applications - Register new application
• GET /api/applications - List all applications
• GET /api/applications/:id - Get application details
• PUT /api/applications/:id - Update application
• DELETE /api/applications/:id - Delete application

Public API Endpoints (Requires API Key)

• GET /api/applications/test/domain - Get application domain description

Authentication

Admin Authentication

Use JWT token in the Authorization header:

Authorization: Bearer <token>

API Authentication

Use API key in the X-API-Key header:

X-API-Key: <api-key>

Security

The platform implements several security measures:

• JWT authentication for users
• API key authentication for applications
• Rate limiting
• Helmet security headers
• CORS protection
• Input validation

License

MIT