flutter_easy_swagger_generator 0.0.3

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.

Features

• Generates complete clean architecture structure
• Supports all OpenAPI 3.0 features
• Generates models, repositories, and network layers
• Handles complex data types and references
• Supports multipart/form-data
• Includes code formatting
• Supports both local files and remote URLs
• Generates BLoC pattern for state management
• Includes dependency injection setup
• Creates result builders for better state mangment

Installation

Add this package to your pubspec.yaml:

dependencies:
  flutter_easy_swagger_generator: ^latest

Usage

Basic Usage

import 'package:flutter_easy_swagger_generator/flutter_easy_swagger_generator.dart';

void main(List<String> arguments) async {
  // Generate code from a local swagger file
  await swaggerGenerator('path/to/swagger.json');
  
  // Or generate from a remote URL
  await swaggerGenerator('https://api.example.com/swagger.json');
}

Parameters

• swaggerPath (String): Path to the Swagger file or URL to the Swagger specification.
• category (String?, optional): If provided, only generates code for API paths containing this category.
• prefixesToRemove (List, optional): List of prefixes to remove from generated class and file names.

Command Line

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

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

Example

See the example directory for a complete working example:

import 'package:flutter_easy_swagger_generator/generator/swagger_generator.dart';

void main() async {
  // Example 1: Generate from local swagger file
  await swaggerGenerator('example/swagger.json');

  // Example 2: Generate from remote swagger URL
  await swaggerGenerator('https://petstore.swagger.io/v2/swagger.json');
}

Generate Code for a Single Category

You can generate code for only a specific category of API paths using swaggerSingleCategoryGenerator:

import 'package:flutter_easy_swagger_generator/flutter_easy_swagger_generator.dart';

void main(List<String> arguments) async {
  // Generate code for only the 'user' category
  await swaggerSingleCategoryGenerator('path/to/swagger.json', 'user');

  // Generate code for the 'order' category, removing specific prefixes
  await swaggerSingleCategoryGenerator('path/to/swagger.json', 'order', prefixesToRemove: ['Api', 'Dto']);
}

Parameters

• swaggerPath (String): Path to the Swagger file or URL to the Swagger specification.
• 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

The generator creates the following structure:

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

Features

Entity Generation

• Automatically generates Dart classes from OpenAPI schemas
• Handles nested objects and arrays
• Supports all primitive types
• Generates proper null safety

Repository Generation

• Creates repository interfaces
• Generates repository implementations
• Handles CRUD operations
• Supports custom methods

Network Layer

• Generates API clients
• Handles authentication
• Supports all HTTP methods
• Manages request/response types

Presentation Layer

• Generates BLoC pattern implementation
• Creates events for user actions
• Generates state classes for UI updates
• Follows Flutter best practices

Application Layer

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

Dependency Injection

• Sets up dependency injection
• Configures service locators
• Manages module dependencies

Result Handling

• Generates result builders for error handling
• Provides consistent error management
• Supports all patterns for success/failure/loading

Code Formatting

• Automatically formats generated code
• Follows Dart style guidelines
• Maintains consistent formatting

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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