diff --git a/pkgs/shelf_router/README.md b/pkgs/shelf_router/README.md index 0fe6f398..827fb064 100644 --- a/pkgs/shelf_router/README.md +++ b/pkgs/shelf_router/README.md @@ -18,16 +18,23 @@ import 'package:shelf_router/shelf_router.dart'; import 'package:shelf/shelf.dart'; import 'package:shelf/shelf_io.dart' as io; -var app = Router(); +// instantiate a router and configure your routes +var router = Router(); -app.get('/hello', (Request request) { +router.get('/hello', (Request request) { return Response.ok('hello-world'); }); -app.get('/user/', (Request request, String user) { +router.get('/user/', (Request request, String user) { return Response.ok('hello $user'); }); +// use a Pipeline to configure your middleware, +// then add the router as the handler +final app = const Pipeline() + .addMiddleware(logRequests()) + .addHandler(router); + var server = await io.serve(app, 'localhost', 8080); ``` diff --git a/pkgs/shelf_router/example/main.dart b/pkgs/shelf_router/example/main.dart index fb57d61f..275c9805 100644 --- a/pkgs/shelf_router/example/main.dart +++ b/pkgs/shelf_router/example/main.dart @@ -53,7 +53,11 @@ class Service { return Response.notFound('Page not found'); }); - return router.call; + // Set up your Pipeline with any middleware you want to use and set the + // router as the handler. + return const Pipeline() + .addMiddleware(logRequests()) + .addHandler(router.call); } }