README
¶
SweetRPG Game Systems API
HTTP microservice that owns the platform-wide catalog of game systems (ruleset/edition, name,
publisher reference, metadata). A Gin-based Go service, matching catalog-api's conventions,
backed by its own MongoDB database.
catalog-api resolves a Volume's system references against this service rather than
maintaining its own copy - see sweetrpg/platform's openspec/changes/game-systems-service for
the full design.
Run locally
go run ./cmd/gamesystems-api
Needs a MongoDB instance reachable per mongodb.go's DB_* environment variables (DB_URI, or
DB_HOST/DB_SCHEME/DB_USER/DB_PW/DB_NAME/DB_PORT/DB_OPTS).
Documentation
Package documentation: pkg.go.dev/github.com/sweetrpg/gamesystems-api.
Contributing
See CONTRIBUTING.md for the development workflow.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package authz calls auth-api's POST /authz/check to verify a caller's bearer token and resolve their roles, and provides Gin middleware that gates a route on holding one of a set of allowed roles.
|
Package authz calls auth-api's POST /authz/check to verify a caller's bearer token and resolve their roles, and provides Gin middleware that gates a route on holding one of a set of allowed roles. |
|
cmd
|
|
|
gamesystems-api
command
|
|
|
migrate-system-ids
command
|
|
Click to show internal directories.
Click to hide internal directories.