Public API Reference

Entry Point

crateSetup

Creates a CrateRouter integrated with a vibe.d URLRouter.

Single Policy

auto crateRouter = router.crateSetup;           // Default: RestApi
auto crateRouter = router.crateSetup!RestApi;    // Explicit
auto crateRouter = router.crateSetup!Mcp;        // MCP only

Multiple Policies

auto crateRouter = router.crateSetup!(RestApi, Mcp);
auto crateRouter = router.crateSetup!(RestApi, Mcp, GraphQL);

Returns: CrateRouter!(Policies...)

run

Start an HTTP server and event loop. For quick prototyping and tutorials.

router.run();         // Default port 8080
router.run(9090);     // Custom port

Returns: int (event loop exit code)

---

CrateRouter Methods

add

Register a model with all configured policies. Auto-discovers @Action methods. Accepts optional middleware.

crateRouter.add(userCrate);
crateRouter.add(userCrate, authMiddleware, filterMiddleware);

Returns: CrateRouter (for chaining)

prepare

Register a model with all policies and return the router for further configuration (custom operations, expose, etc.).

auto prepared = crateRouter.prepare(userCrate);
prepared
  .withCustomOperation(myOp)
  .and(authMiddleware);

Returns: TypeRouter (single policy) or BlankRouter[] (multiple policies)

prepareFor

Register a model with only the specified policies.

// User only gets REST, not MCP
crateRouter.prepareFor!(RestApi)(userCrate);

// Space gets both
crateRouter.prepareFor!(RestApi, Mcp)(spaceCrate);

Returns: TypeRouter (single selected policy) or BlankRouter[] (multiple selected policies)

addFor

Like add, but only registers with selected policies. Accepts middleware.

crateRouter.addFor!(RestApi)(userCrate, authMiddleware);

Returns: CrateRouter (for chaining)

enable

Enable OAuth2 authentication globally for all routes.

crateRouter.enable(oAuth2Instance);

Returns: CrateRouter (for chaining)

blank

Create a standalone BlankRouter for custom operations that don’t belong to any model.

crateRouter.blank()
  .withCustomOperation(healthCheckOp);

Returns: BlankRouter

rules

Get all routing rules across all registered routers.

auto allRules = crateRouter.rules();

Returns: CrateRule[]

match

Find the operation matching an HTTP method and path.

auto op = crateRouter.match(HTTPMethod.GET, "/users");
auto op = crateRouter.match(HTTPMethod.POST, "/mcp", requestBody);  // Body-matched

Returns: IApiOperation or null

---

TypeRouter Methods

Returned by prepare() and prepareFor() when a single policy is selected.

and

Apply middleware to all operations on this router.

crateRouter.prepare(userCrate)
  .and(authMiddleware)
  .and(filterMiddleware);

Returns: TypeRouter (for chaining)

withCustomOperation

Add a custom IApiOperation to this router.

crateRouter.prepare(userCrate)
  .withCustomOperation(new MyCustomOperation);

Returns: TypeRouter (for chaining)

expose

Expose a model’s @Action method as an HTTP endpoint.

crateRouter.prepare(userCrate)
  .expose!"archive";   // Exposes User.archive() as an endpoint

Returns: TypeRouter (for chaining)

itemOperation

Add a custom operation scoped to a single item (:id in path).

crateRouter.prepare(userCrate)
  .itemOperation!("download", downloadOp);

Returns: TypeRouter (for chaining)

---

BlankRouter[] UFCS Functions

When multiple policies are selected, prepare() and prepareFor() return BlankRouter[]. These UFCS functions forward calls to every router in the array:

and

crateRouter.prepare(userCrate)   // Returns BlankRouter[]
  .and(authMiddleware);          // Applied to all policy routers

Returns: BlankRouter[] (for chaining)

withCustomOperation

crateRouter.prepare(userCrate)
  .withCustomOperation(myOp);   // Added to all policy routers

Returns: BlankRouter[] (for chaining)

---

Available Policies

Policy	Module	Routing	Description
RestApi	crate.protocols.restApi.policy	Path-based	Standard REST endpoints
JsonApi	crate.protocols.jsonApi.policy	Path-based	JSON:API compliant endpoints
Mcp	crate.protocols.mcp.policy	Body-matched	Model Context Protocol (JSON-RPC)
GraphQL	crate.protocols.graphql.policy	Body-matched	GraphQL queries and mutations

PolicyConfig

Customize the base URL for any policy:

auto crateRouter = router.crateSetup!(
  RestApiPolicy!(PolicyConfig("/api/v1")),
  McpPolicy!(PolicyConfig("/mcp"))
);

---

CrateConfig

Control which CRUD operations are enabled per model:

auto config = CrateConfig!User;
config.deleteItem = false;  // Disable DELETE
config.replaceItem = false; // Disable PUT

auto crate = new MongoCrate!User(collection, config);

Field	Default	Description
getList	true	GET /resources
getItem	true	GET /resources/:id
addItem	true	POST /resources
deleteItem	true	DELETE /resources/:id
replaceItem	true	PUT /resources/:id
updateItem	true	PATCH /resources/:id
singular	auto	Singular name for URLs/keys
plural	auto	Plural name for URLs/keys

---

Global Registry

crateGetters

Maps model names to their getItem functions. Required for relation resolution during POST/PATCH.

crateGetters["Team"] = &teamCrate.getItem;
crateGetters["Picture"] = &pictureCrate.getItem;

Registered automatically by prepare()/prepareFor() for the model being added. You must register getters manually for any models that the added model references.