retrofit_craft_plugin 0.10.0

craft_runner builder that generates a grouped, versioned retrofit API client aggregator.

retrofit_craft_plugin

A craft_runner builder that generates a grouped, versioned retrofit API client aggregator (AppApi) from retrofit_craft annotations.

It scans every Dart file in scope, finds the @Api-annotated retrofit classes plus the Entry and Version subclasses, and emits a single standalone file:

final api = AppApi(dio: Dio());
api.identity.auth.v1.login(phone: '...', password: '...');
api.consumer.order.v2.checkout(cart);

Wiring

Declare it in craft_runner.yaml:

roots: [lib]

builders:
  retrofit_craft_plugin:RetrofitCraftBuilder:
    default_entry: Identity
    default_version: V1
    entry_path: lib/app/api/entries.dart
    version_path: lib/app/api/versions.dart
    output: lib/app/app_api.craft.dart
    root_class_name: AppApi

Then run craft_runner craft once, or craft_runner watch to regenerate on save.

See retrofit_craft for the annotation reference and examples/retrofit_aggregator for a complete fixture.

How the generation works

• The builder discovers Entry/Version subclasses anywhere in scope (or in the configured entry_path / version_path).
• For every @Api(entry: <X>(), version: <Y>()) retrofit class:
  • The field name on the entry wrapper is derived from the class name: strip a trailing V<digits>, then Api, then lowercase the first letter (AuthApiV1 -> auth).
  • Multiple classes in the same (entry, group) are versioned siblings; each becomes v<n> on a generated _<Entry><Group>Versions wrapper.
  • A single class with no version (and no default_version) becomes a direct field on the entry wrapper (no version layer).
• baseUrl is emitted as const <EntryClass>().baseUrl so the Entry subclass remains the single source of truth at runtime (env-driven, lazy, etc.).
• When two source files contain a Dart class with the same name (e.g. two AuthApis in different folders), the generator uses import ... as _aliasN and qualifies the reference.

Status

Alpha, part of the riverpod_craft ecosystem.