Routing

Routing is the first step of the request flow. It is implemented using the ASP.NET Core routing engine. Routing matches a route defined with one of the many routing builder methods to the request path of an incoming HTTP request.

Every builder method that sets up a route can take in a string parameter that defines the route pattern. The route pattern is compatible with ASP.NET core templates and defines which request paths will match with the route.
For a route to actually be matched and executed by Seltzr, it must include the following
- At least one supported request method (GET, POST, etc.)
- A Result Writer to serialize a response

Builder Methods

Low-Level Methods

These methods are for more low-level routing, that don't define any request methods or operations.

Request Methods

These methods set request methods for the current route, but don't create a new route

Basic Routing

These methods setup a new route that supports the given request method. They each have three overloads:

The first accepts no parameters, and sets up a route on the same pattern with no additional options. In practice, this is usually equivalent to calling Can{Method} for the method.
The second accepts a callback for configuring the route, and sets up the route on the same pattern as its parent
The third accepts both a route pattern and a callback, and sets up the route on a pattern that combines the parent route pattern with the given route pattern.

GET

POST

PUT

PATCH

DELETE

Routing with Operations

These methods are only available when using an ORM-backed version of Seltzr, and set up a request method and operation and sometimes additional configuration. They generally follow the same 3-overload pattern as the methods above.

DELETE

GET

PATCH

POST (Create)

POST (Update)

PUT

Note

There are a lot of builder methods for creating routes with an ORM--don't try to memorize them all! Instead, remember the general categories that they fall into:

Updating
- UpdateBy TODO!

Important

Options set by builder methods cascade through routes. This means that that the innermost route in the below example inherits all of the options set before it, including the route pattern, set by its parent routes.

app.UseSeltzr<MyModel>("v1", api => {
    api
  	.MapRoute("alpha", alpha => {
  		// this route, /v1/alpha, will NOT parse JSON or use GET.
  	})
  	.CanGet()
  	.ParseJson()
  	.MapRoute("beta", beta => {
  		// this route, /v1/beta, WILL parse JSON and support GET.
  	});
});

Examples

Also todo

generic routing
by primary key (route, query, body)
update that doesn't use primary key
creation
get