Documentation
¶
Overview ¶
Package simple is an application whose doors come from builder annotations: app api serves REST routes on two echo servers (rest and admin), a gRPC health service and the check_stock MCP tool; app order-worker records the orders of order.created events; app stock-audit is a job that checks the stock of a list of items once and exits.
Regenerate gen/ with:
go generate ./builder/examples/simple
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
api
command
Command api runs app api: the doors builder generates in github.com/xgodev/boost/builder/examples/simple/gen/builder/api.
|
Command api runs app api: the doors builder generates in github.com/xgodev/boost/builder/examples/simple/gen/builder/api. |
|
order-worker
command
Command order-worker runs app order-worker: the doors builder generates in github.com/xgodev/boost/builder/examples/simple/gen/builder/order-worker.
|
Command order-worker runs app order-worker: the doors builder generates in github.com/xgodev/boost/builder/examples/simple/gen/builder/order-worker. |
|
stock-audit
command
Command stock-audit runs app stock-audit: the doors builder generates in github.com/xgodev/boost/builder/examples/simple/gen/builder/stock-audit.
|
Command stock-audit runs app stock-audit: the doors builder generates in github.com/xgodev/boost/builder/examples/simple/gen/builder/stock-audit. |
|
Package createorder serves the order routes of app api.
|
Package createorder serves the order routes of app api. |
|
Package healthcheck serves grpc.health.v1.Health on the grpc server of app api.
|
Package healthcheck serves grpc.health.v1.Health on the grpc server of app api. |
|
Package order keeps the orders of the example in memory.
|
Package order keeps the orders of the example in memory. |
|
Package ordercreated records the orders of order.created events in app order-worker.
|
Package ordercreated records the orders of order.created events in app order-worker. |
|
Package probe answers the liveness probe on the admin server of app api, apart from the public routes.
|
Package probe answers the liveness probe on the admin server of app api, apart from the public routes. |
|
Package stock tells whether an item can be ordered.
|
Package stock tells whether an item can be ordered. |
|
memory
Package memory keeps the stock in memory.
|
Package memory keeps the stock in memory. |
|
remote
Package remote asks a warehouse over HTTP for the stock.
|
Package remote asks a warehouse over HTTP for the stock. |
|
unlimited
Package unlimited is a stock without limits.
|
Package unlimited is a stock without limits. |
|
Package stockaudit checks the stock of a list of items in app stock-audit, a job: the app runs the audit once and exits, the shape of a CronJob.
|
Package stockaudit checks the stock of a list of items in app stock-audit, a job: the app runs the audit once and exits, the shape of a CronJob. |
|
Package stocktool serves the stock tools of app api over MCP.
|
Package stocktool serves the stock tools of app api over MCP. |
Click to show internal directories.
Click to hide internal directories.