darto_openapi library

OpenAPI 3.1 spec generation and Scalar API docs for the Darto web framework.

Describe a route once — it is mounted on the app (validating the request body) and recorded for the generated OpenAPI document.

import 'package:darto/darto.dart';
import 'package:darto_openapi/darto_openapi.dart';

final app = Darto();
final api = OpenApi(app, info: Info(title: 'Blog API', version: '1.0.0'));

api.post('/posts',
  summary: 'Create a post',
  tags: ['posts'],
  request: Req(json: Schema.object({
    'title': Schema.string(minLength: 1), // required by default
  })),
  responses: {201: Res('Created')},
  handler: (c) => c.created(c.req.valid('json')),
);

app.use(api.docs()); // serves /openapi.json and /docs (Scalar)
await app.listen(3000);

Classes

Info

OpenAPI info object.

OpenApi

OpenAPI 3.1 registry for a Darto app.

Req

The request contract for a route — documents and validates.

Res

A documented response.

Schema

A schema builder that doubles as a validator and an OpenAPI 3.1 Schema Object generator.

SecurityScheme