Overview

Revali is a Dart framework for HTTP APIs. You write annotated controller classes; Revali generates the server code from them and runs it. Optional constructs generate more from the same annotations: a typed Dart client, an OpenAPI document, a Dockerfile.

At a glance#

import 'package:revali_router/revali_router.dart';

@Controller('users')
class UsersController {
  const UsersController(this.users);

  final UserService users;

  @Get(':id')
  Future<User> find(@Param() String id) => users.find(id);

  @Post()
  Future<User> create(@Body() User user) => users.create(user);
}

That controller serves GET /api/users/:id and POST /api/users, with the path parameter and body parsed, validated and injected. UserService comes from dependency injection.

How it works#

1. revali dev or revali build analyzes the files in routes/.
2. The built-in server construct generates routing code into .revali/server/. Any other constructs you depend on generate their own output alongside it.
3. The generated server runs on revali_router. In dev it restarts whenever a file changes.

Conventions#

• URLs are /{prefix}/{controller path}/{method path}. The prefix defaults to api. Method names are never part of the URL.
• Responses: return values are JSON wrapped as {"data": ...}. Return StringContent or set response.body to send something else.
• Bad input: a missing or invalid bound parameter is answered with 400 Bad Request before your method runs.
• Cross-cutting logic (auth, logging, error mapping) goes in lifecycle components in lib/components/.

Start here#

1. Installation
2. Create your first endpoint
3. Run the server

Then, as you need them: app configuration, testing, the server reference, and, for systems with several services, messaging, revali up and revali compose.