README
¶
SweetRPG Game Room API
HTTP microservice for the SweetRPG Game Room domain (library, wishlist, tables, visibility).
Migrated from Python to Go to match the platform's Go microservice baseline. A thin Gin-based
layer: server/*.go wires JSON:API routes to game-room-data.go's data-access functions.
Building
go build -v ./...
Testing
go test -v -coverprofile coverage.out ./...
Documentation
API documentation is available at http://localhost:8000/swagger/index.html when the server is
running. See service-conventions.md in the platform repo for more details on the Go
microservice baseline.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package authz calls auth-api's POST /authz/check to resolve a caller's identity (subject).
|
Package authz calls auth-api's POST /authz/check to resolve a caller's identity (subject). |
|
Package cachettl resolves the cache TTL for a given route group, loaded once at startup from the CACHE_TTLS env var so slower-changing entities and faster-changing ones aren't forced onto the same cache policy.
|
Package cachettl resolves the cache TTL for a given route group, loaded once at startup from the CACHE_TTLS env var so slower-changing entities and faster-changing ones aren't forced onto the same cache policy. |
|
cmd
|
|
|
game-room-api
command
|
|
|
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
|
Package ratelimit implements a Redis-backed, per-client, per-route-tier request rate limiter.
|
Package ratelimit implements a Redis-backed, per-client, per-route-tier request rate limiter. |
|
Package readiness tracks the reachability of backend dependencies (beyond Mongo, which api-core.go's HealthHandler already covers) so /status/health can fail loud instead of the service silently degrading to an uncached or unlimited mode.
|
Package readiness tracks the reachability of backend dependencies (beyond Mongo, which api-core.go's HealthHandler already covers) so /status/health can fail loud instead of the service silently degrading to an uncached or unlimited mode. |
Click to show internal directories.
Click to hide internal directories.