flutter_easy_swagger_generator 1.0.0

A Flutter package for generating Dart models and API clients from Swagger/OpenAPI specifications.

Flutter Easy Swagger Generator

A Flutter package that automatically generates Clean Architecture code from Swagger/OpenAPI specifications.

This version (1.0.0) adds a standalone CLI, improved model generation, multipart/form-data support, full HTTP method support, and enhanced developer experience.

Features

• Generates a complete Clean Architecture structure (domain, infrastructure, presentation, application)
• Supports OpenAPI 3.0 features
• Generates models, repositories, and network layers
• Handles nested objects, arrays, and complex data types
• Supports multipart/form-data requests
• Handles all HTTP methods (GET, POST, PUT, DELETE)
• Automatically serializes header, query, and body parameters
• Generates BLoC pattern for state management
• Includes dependency injection setup with get_it
• Creates result builders for consistent state and error management
• Supports local files and remote URLs
• Automatically formats generated code according to Dart guidelines

Installation

Add this package to your pubspec.yaml:

dependencies:
  flutter_easy_swagger_generator: ^1.0.0

Usage

CLI Usage

# Generate from a local file
dart run flutter_easy_swagger_generator path/to/swagger.json

# Generate from a remote URL
dart run flutter_easy_swagger_generator https://api.example.com/swagger.json

Dart API Usage

import 'package:flutter_easy_swagger_generator/flutter_easy_swagger_generator.dart';

void main() async {
  // Generate code from a local Swagger file
  await swaggerGenerator('path/to/swagger.json');

  // Or generate from a remote Swagger URL
  await swaggerGenerator('https://api.example.com/swagger.json');
}

Parameters

• swaggerPath (String): Path or URL to the Swagger JSON file.
• category (String?, optional): Generate code only for a specific API path category.
• prefixesToRemove (List, optional): Remove specified prefixes from generated class/file names.

Parameters

• swaggerPath (String): Path or URL to the Swagger JSON file.
• category (String): The category string to filter API paths.
• prefixesToRemove (List, optional): List of prefixes to remove from generated class and file names.

Generated Structure

lib/
  ├── app/
  │   ├── domain/
  │   │   ├── entities/
  │   │   └── repositories/
  │   ├── infrastructure/
  │   │   ├── models/
  │   │   ├── remote/
  │   │   └── repositories_implementation/
  │   ├── network/
  │   │   └── routes/
  │   ├── presentation/
  │   │   ├── bloc/
  │   │   ├── event/
  │   │   └── state/
  │   ├── application/
  │   │   └── use_cases/
  │   └── injection/

Layer Features

Entity Generation

• Converts OpenAPI schemas into Dart classes
• Handles nested objects and arrays
• Supports null safety

Repository Generation

• Creates repository interfaces and implementations
• Supports CRUD operations and custom methods

Network Layer

• Generates API clients
• Handles authentication
• Supports all HTTP methods
• Correctly maps request and response types

Presentation Layer

• Generates BLoC implementation
• Creates events and state classes for UI
• Follows Flutter best practices

Application Layer

• Generates use cases for business logic
• Separates concerns between layers
• Implements clean architecture principles

Dependency Injection

• Sets up service locators
• Configures module dependencies

Result Handling

• Generates result builders
• Provides consistent success/failure/loading handling

Code Formatting

• Auto-formats all generated files
• Maintains consistent Dart style

Contributing

Contributions are welcome! Please submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.