JVM - api.all()
Register an API route and set a specific HTTP handler on that route.
This method is a convenient short version of api().route().all](./api-route-all)
import io.nitric.Nitric;public class Application {public static void main(String[] args) {var api = Nitric.INSTANCE.api("public");api.all("/customers", (ctx) -> {// handle requestreturn ctx;});Nitric.INSTANCE.run();}}
Parameters
- Name
match
- Required
- Required
- Type
- String
- Description
The path matcher to use for the route. Matchers accept path parameters in the form of a colon prefixed string. The string provided will be used as that path parameter's name when calling middleware and handlers. See create a route with path params
- Name
middleware
- Required
- Required
- Type
- HttpMiddleware or List<HttpMiddleware>
- Description
One or more middleware functions to use as the handler for HTTP requests. Handlers can be sync or async
Examples
Register a handler for all requests
import io.nitric.Nitric;public class Application {public static void main(String[] args) {var api = Nitric.INSTANCE.api("public");api.all("/customers", (ctx) -> {// handle requestreturn ctx;});Nitric.INSTANCE.run();}}
Chain functions as a single method handler
When multiple functions are provided they will be called as a chain. If one succeeds, it will move on to the next. This allows middleware to be composed into more complex handlers.
import io.nitric.Nitric;import io.nitric.faas.v0.HttpContext;import io.nitric.faas.v0.Handler;import java.util.List;public class Application {static HttpContext validateRequest(HttpContext ctx, Handler<HttpContext> next) {// validateRequestreturn next.invoke(ctx);}static HttpContext handleRequest(HttpContext ctx, Handler<HttpContext> next) {// handle requestreturn next.invoke(ctx);}public static void main(String[] args) {var api = Nitric.INSTANCE.api("public");api.all("/customer", List.of(Application::validateRequest, Application::handleRequest));Nitric.INSTANCE.run();}}
Access the request body
The request body is accessible from the ctx.req
object.
import io.nitric.Nitric;public class Application {public static void main(String[] args) {var api = Nitric.INSTANCE.api("public");api.all("/customer", (ctx) -> {var customerData = ctx.getReq().getData();// parse, validate, and store the request payload...});Nitric.INSTANCE.run();}}
Last updated on Oct 11, 2024