API Sentinel is a comprehensive dashboard application for monitoring API security, health, and compliance. It provides real-time insights into API performance, security metrics, and post-quantum cryptography readiness.
Image will be added later
- 🔒 Real-time security score tracking with customizable thresholds
- 🔍 Vulnerability trend analysis with ML-powered predictions
- 🚀 Post-quantum cryptography readiness assessment
- 🛡️ Automated security scanning and reporting
- 📊 Live service status monitoring with uptime tracking
- ⚡ Performance metrics with historical data
- 🎯 SLA compliance monitoring
- 🔄 Automated health checks and alerts
- 📈 Interactive charts and customizable dashboards
- 📱 Real-time mobile notifications
- 📊 Custom metric tracking and reporting
- 📉 Trend analysis and forecasting
- ✅ Automated compliance checks
- 📋 Policy enforcement monitoring
- 🔐 Access control and audit logging
- 📝 Compliance report generation
- Framework: React 18 with TypeScript
- UI Components: Material-UI v5
- State Management: Redux Toolkit
- Data Visualization: Recharts
- API Client: Axios
- Testing: Jest & React Testing Library
- Build Tool: Vite
- Runtime: Go 1.21
- Framework: Gin Web Framework
- Database: SQLite (Development) / PostgreSQL (Production)
- Authentication: JWT with refresh tokens
- API Documentation: Swagger/OpenAPI 3.0
- Testing: Go testing package with testify
- Node.js (v16 or higher)
- Go (v1.21 or higher)
- Git
- Docker (optional)
- Clone and Install Dependencies
git clone https://github.com/radhi1991/API-Sentinel.git
cd API-Sentinel/frontend
npm install- Environment Configuration
cp .env.example .env.local
# Edit .env.local with your configuration- Development Server
npm run dev
# Access the app at http://localhost:3000- Build for Production
npm run build
npm run preview- Install Go Dependencies
cd backend
go mod tidy- Database Setup
# Development (SQLite)
go run cmd/migrate/main.go
# Production (PostgreSQL)
export DB_URL="postgresql://user:password@localhost:5432/api_sentinel"
go run cmd/migrate/main.go- Start the Server
# Development
go run main.go
# Production
go build
./api-sentinelPOST /api/v1/auth/login
POST /api/v1/auth/refresh
POST /api/v1/auth/logoutGET /api/v1/inventory # List all APIs
POST /api/v1/inventory # Register new API
GET /api/v1/inventory/:id # Get API details
PUT /api/v1/inventory/:id # Update API
DELETE /api/v1/inventory/:id # Remove APIGET /api/v1/metrics/security
GET /api/v1/metrics/security/:id/history
POST /api/v1/metrics/security/scanGET /api/v1/metrics/performance
GET /api/v1/metrics/performance/:id/uptime
GET /api/v1/metrics/performance/:id/latency.
├── frontend/
│ ├── src/
│ │ ├── components/ # Reusable UI components
│ │ ├── pages/ # Page components
│ │ ├── services/ # API services
│ │ ├── store/ # Redux store
│ │ ├── theme/ # MUI theme
│ │ └── utils/ # Utility functions
│ └── package.json
│
└── backend/
├── cmd/ # Command-line tools
├── internal/
│ ├── api/ # API handlers
│ ├── middleware/ # Custom middleware
│ ├── models/ # Data models
│ └── services/ # Business logic
├── pkg/ # Shared packages
└── main.go
Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.
This project is licensed under the MIT License - see the LICENSE file for details.
- Project Link: API Sentinel GitHub
- Report Bug: Issue Tracker
- Material-UI team for the excellent UI components
- Recharts team for the powerful charting library
- Go community for the robust backend framework