How dinesheth/olx-api works
OLX API is a small Go HTTP service for health, welcome, and classified-listing reads. At startup it loads environment configuration, opens PostgreSQL, builds handlers and a JSON logger, then registers routes behind request-ID middleware. The listings handler queries and serializes recent rows; the other routes return static JSON. A separate migration command applies or rolls back versioned schema changes. README capabilities are represented, including migrations and structured logging; migration schema details are documented, but the SQL and individual migration command behavior are not sampled.
Main entry points: api/main.go API server · listings.go Listings endpoint · migrate/main.go Migration command · requestId.go Request IDs
Components 15
Service startup
- Environment config
internal/config/config.go - API server
cmd/api/main.go - Structured logger
cmd/api/main.go
HTTP API
- Request IDs
internal/middlewares/requestId.go - Home endpoint
internal/handlers/home.go - Health endpoint
internal/handlers/healthz.go - Listings endpoint
internal/handlers/listings.go
Listings data
- PostgreSQL
- Listing query
internal/handlers/listings.go - JSON listings
internal/handlers/listings.go - DB connection pool
internal/db/db.go
Schema management
- Migration command
cmd/migrate/main.go - Schema migrations
migrations/000001_create_listing_table.up.sql - Rollback migration
migrations/000001_create_listing_table.down.sql
Other components
- HTTP client
Connections 17
- API server → Environment config: loads config
cmd/api/main.go - API server → DB connection pool: opens pool
cmd/api/main.go - DB connection pool → PostgreSQL: connects
internal/db/db.go - API server → Structured logger: creates logger
cmd/api/main.go - API server → Home endpoint: registers route
cmd/api/main.go - API server → Health endpoint: registers route
cmd/api/main.go - API server → Listings endpoint: registers route
cmd/api/main.go - API server → Request IDs: wraps routes
cmd/api/main.go - HTTP client → API server: sends request
README.md - Request IDs → Listings endpoint: dispatches request
internal/middlewares/requestId.go - Listings endpoint → Listing query: runs query
internal/handlers/listings.go - Listing query → PostgreSQL: reads listings
internal/handlers/listings.go - Listings endpoint → JSON listings: encodes rows
internal/handlers/listings.go - Listings endpoint → Structured logger: logs outcomes
internal/handlers/listings.go - Migration command → Environment config: loads config
cmd/migrate/main.go - Migration command → Schema migrations: applies schema
README.md - Migration command → Rollback migration: rolls back
README.md