shelf_router_macro #

🚧 Experimental support for shelf_router using macros.

🌟 Features #

• ✨ Route declarations
• ✨ Route parameters
• ✨ Lightweight - no additional dependencies beyond shelf_router
• 🖊️ In Progress Intuitive - custom return types
• 🖊️ In Progress Minimalistic - no need to specify Request/Response, just return response body

🧑‍💻 Example #

import 'package:data_class_macro/data_class_macro.dart';

@Controller()
class GreetingController {
  @Get('/<name>')
  Response greetingByName(Request request, String name) {
    return Response.ok('Hello, $name!');
  }

  // you can also omit Request/Response
  // WARNING: only String return type is supported for now
  @Get('/wave')
  String wave() {
    return '_o/';
  }
}

void main() async {
  final controller = GreetingController();
  unawaited(
    serve(controller.router, 'localhost', 8080),
  );
  print('✅ Server listening on http://localhost:8080/');

  print('🔍 Testing...');
  (await (await HttpClient().get('localhost', 8080, '/eeqk')).close())
      .transform(utf8.decoder)
      .listen(print); // Hello, eeqk!
}

🚀 Quick Start #

1. Download Dart from dev or master channel

   • Dart SDK archive
   • dvm: Dart Version Manager
   • Alternatively, you can simply switch to flutter master channel:

   $ flutter channel master
   

2. Add package:shelf_router_macro to your pubspec.yaml

   $ dart pub add shelf_router_macro
   

3. Enable experimental macros in analysis_options.yaml

   analyzer:
     enable-experiment:
       - macros
   

4. Use annotations provided by this library (see above example).

5. Run it

   $ dart --enable-experiment=macros run lib/main.dart