Sashimi API Gateway

WORK IN PROGRESS

A Lightweight API Gateway built in Golang to learn more about API infrastructure and microservices

Architecture

## Reverse Proxy

Features

• Request Analytics
• Authentication Provider
• Rate Limiting
• Admin API (API Onboarding and offboarding)
• Reverse Proxy
• API Health Checks
• GUI Application

Functional Requirements

Request Routing

• The API gateway should be able to route incoming HTTP(S) requests to specific services based on URL paths, HTTP methods, and other request attributes.

Authentication & Authorization

• The gateway should be able to validate tokens (e.g., JWT) and decide if a request should proceed.

Rate Limiting

• To prevent abuse, the gateway should limit the number of requests a client can make in a given time frame. This could be global, per user, per IP, or per service.

Logging & Monitoring

• All requests and responses should be logged for auditing and debugging purposes.
• Integrations with monitoring tools to track response times, error rates, and other important metrics.

Service Discovery Integration

• As services can be dynamically added or removed, the API gateway should integrate with service discovery mechanisms to know where to route requests.

Security

• Support for HTTPS with SSL/TLS termination.

Health Checks

• The gateway should implement periodic health checks to verify the status and availability of integrated API services.
• The health check mechanism should be configurable, allowing for adjustments to the frequency and conditions of checks.

To do

• Requires big infrastructure refactor (code is messy and in a POC state) can consider clean architecture in golang or domain driven design
• Split the rev. proxy, cron jobs, admin api into different microservices, write docker-compose to start all containers easily
• Introduce redis as caching (lazy loading or write through)
• Introduce rate limiting into rev. proxy
• Incorporate credentials into manager GUI and test functionality
• Write unit tests, integration tests and e2e tests
• Write simple script to startup service with configured environment variables OR kubernetes/helm to deploy

Multiple Golang applications

go work init
go work use ./admin-api ./salmon-api ./tuna-api