🧬 Swagger Dart Generator

You run the generator once and you instantly get a package you can import in any Flutter / Dart project to call your backend.

💻 Installation

dart pub global activate swagger_dart_generator

Usage

Run the command with the path to your swagger.json. The tool will generate a Dart package structure

swagger_dart_generator

Import and use in your app

dependencies:
  example:
    path: example
    version: 1.0.0

import 'package:dio/dio.dart';
import 'package:example/example.dart';
import 'package:example/data/models/auth/requests/authlogin_req.dart';

void main() async {
  final dio = Dio(BaseOptions(baseUrl: 'https://api.example.com'));
  final api = Example.init(dio);
  final loginResult = await api.repository.auth.authlogin(AuthloginReq());
  loginResult.fold(
    (failure) => print('❌ ${failure.message}'),
    (success) => print('✅ Logged in: $success'),
  );
}

📂 Generated Files Structure

DataSource Abstract

import 'package:dio/dio.dart';
import 'package:example/data/models/auth/requests/login_post_req.dart';
import 'package:example/data/models/auth/responses/login_post_res.dart';

abstract class AuthDataSource {
  Future<LoginPostRes> loginPost(LoginPostReq req, {CancelToken? cancelToken, void Function(int, int)? onReceiveProgress, Options? options});
}

DataSource Implementation

import 'package:dio/dio.dart';
import 'package:example/data/datasources/auth/auth.dart';
import 'package:example/data/models/auth/requests/login_post_req.dart';
import 'package:example/data/models/auth/responses/login_post_res.dart';
import 'package:example/end_points.dart';

class AuthRemoteDataSourceImpl implements AuthDataSource {
  final Dio _dio;
  AuthRemoteDataSourceImpl(this._dio);

  @override
  Future<LoginPostRes> loginPost(LoginPostReq req, {CancelToken? cancelToken, void Function(int, int)? onReceiveProgress, Options? options}) async {
    String url = EndPoints.auth.loginPost;
    final result = await _dio.post(url, data: req.body?.toJson(), cancelToken: cancelToken, onReceiveProgress: onReceiveProgress, options: options);
    return LoginPostRes.fromJson(result.data);
  }
}

Model Request

{
  "body": {
    "email": "string",
    "password": "string"
  }
}

// ignore_for_file: invalid_annotation_target

import 'package:freezed_annotation/freezed_annotation.dart';
import 'dart:convert';

part 'login_post_req.freezed.dart';
part 'login_post_req.g.dart';

LoginPostReq loginPostReqFromJsonString(String str) => LoginPostReq.fromJson(json.decode(str));

String loginPostReqToJsonString(LoginPostReq data) => json.encode(data.toJson());

@freezed
abstract class LoginPostReq with _$LoginPostReq {
  const factory LoginPostReq({
    @JsonKey(name: "body", includeIfNull: false) LoginPostReqBody? body,
}) = _LoginPostReq;

  factory LoginPostReq.fromJson(Map<String, dynamic> json) => _$LoginPostReqFromJson(json);
}


LoginPostReqBody loginPostReqBodyFromJsonString(String str) => LoginPostReqBody.fromJson(json.decode(str));

String loginPostReqBodyToJsonString(LoginPostReqBody data) => json.encode(data.toJson());

@freezed
abstract class LoginPostReqBody with _$LoginPostReqBody {
  const factory LoginPostReqBody({
    @JsonKey(name: "email", includeIfNull: false) String? email,
    @JsonKey(name: "password", includeIfNull: false) String? password,
}) = _LoginPostReqBody;

  factory LoginPostReqBody.fromJson(Map<String, dynamic> json) => _$LoginPostReqBodyFromJson(json);
}

Model Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expiresIn": 1
}

// ignore_for_file: invalid_annotation_target

import 'package:freezed_annotation/freezed_annotation.dart';
import 'dart:convert';

part 'login_post_res.freezed.dart';
part 'login_post_res.g.dart';

LoginPostRes loginPostResFromJsonString(String str) => LoginPostRes.fromJson(json.decode(str));

String loginPostResToJsonString(LoginPostRes data) => json.encode(data.toJson());

@freezed
abstract class LoginPostRes with _$LoginPostRes {
  const factory LoginPostRes({
    @JsonKey(name: "accessToken", includeIfNull: false) String? accessToken,
    @JsonKey(name: "refreshToken", includeIfNull: false) String? refreshToken,
    @JsonKey(name: "expiresIn", includeIfNull: false) int? expiresIn,
}) = _LoginPostRes;

  factory LoginPostRes.fromJson(Map<String, dynamic> json) => _$LoginPostResFromJson(json);
}

Repository Abstract

import 'package:dartz/dartz.dart';
import 'package:dio/dio.dart';
import 'package:example/failure.dart';
import 'package:example/data/models/auth/requests/login_post_req.dart';
import 'package:example/data/models/auth/responses/login_post_res.dart';

abstract class AuthRepository {
  Future<Either<FailureDetails, LoginPostRes>> loginPost(LoginPostReq req, {CancelToken? cancelToken, void Function(int, int)? onReceiveProgress, Options? options});
}

Repository Implementation

import 'package:example/failure.dart';
import 'package:dartz/dartz.dart';
import 'package:dio/dio.dart';
import 'package:example/data/repositories/auth/auth.dart';
import 'package:example/data/datasources/auth/auth.dart';
import 'package:example/data/models/auth/requests/login_post_req.dart';
import 'package:example/data/models/auth/responses/login_post_res.dart';

class AuthRepositoryImpl implements AuthRepository {
  final Failure failure;
  final AuthDataSource _dataSource;

  AuthRepositoryImpl(this._dataSource, this.failure);

  @override
  Future<Either<FailureDetails, LoginPostRes>> loginPost(LoginPostReq req, {CancelToken? cancelToken, void Function(int, int)? onReceiveProgress, Options? options}) async {
    try {
      final result = await _dataSource.loginPost(req, cancelToken: cancelToken, onReceiveProgress: onReceiveProgress, options: options);
      return Right(result);
    } catch (e, stackTrace) {
      return Left(failure.handle(e, stackTrace));
    }
  }

}

EndPoints

class EndPoints {
  static const auth = _Auth();
  static const user = _User();
  static const product = _Product();
}

class _Auth {
  const _Auth();
  final String loginPost = "/auth/login";
}

class _User {
  const _User();
  final String userGet = "/user/{userId}";
}

class _Product {
  const _Product();
  final String productsGet = "/products";
  final String productsPost = "/products";
  final String productsDelete = "/products/{id}";
}

Failure

abstract class Failure {
  const Failure();
  FailureDetails handle(dynamic e, StackTrace stackTrace);
}

class DefaultFailure extends Failure {
  const DefaultFailure();
  @override
  FailureDetails handle(dynamic e, StackTrace stackTrace) {
    return FailureDetails(message: e.toString(), stackTrace: stackTrace);
  }
}

class FailureDetails {
  final String message;
  final StackTrace stackTrace;
  final bool show;
  final Object? extra;
  const FailureDetails({required this.message, required this.stackTrace, this.show = true, this.extra});
}

🤝 Contributing

Pull requests, issues and feature‑requests are welcome!
If you find bugs or want to support new features (e.g., caching, plugin support) open an issue.

📄 License

MIT © 2025 Mohamad Alghanem