swagger_dart_code_generator
4.1.1, released 11 months ago by mobilepeople.dev
Generates Dart models and Chopper API client code from Swagger and OpenAPI schemas.
What it does
Parses Swagger or OpenAPI JSON/YAML schema files to automatically generate Dart data models, enums, converter mappings, and Chopper client request methods. It integrates with build_runner and json_serializable for serialization.
AI-written summary of version 4.1.1, based on the package's README and metadata. Report an inaccuracy
Use it when
- You are working with a backend that provides a Swagger or OpenAPI specification.
- You use Chopper as your HTTP client and want to automate API boilerplate creation.
Skip it when
- You prefer writing your network requests and data models manually.
- Your backend does not provide an OpenAPI or Swagger schema file.
Strengths
- Automates creation of extensive models and API requests from schemas.
- Highly configurable through build.yaml (supports custom scalars, default values, paths filtering).
Weaknesses
- Requires maintaining and running build_runner for code generation.
- Tight coupling with Chopper and json_serializable.
Setup
- Kind
- Pure Dart
- Effort
- Medium
- Code generation
- Yes (build_runner)
- Direct dependencies
- 11
Add chopper, json_annotation, build_runner, chopper_generator, json_serializable, and swagger_dart_code_generator to pubspec.yaml, then configure build.yaml and run dart run build_runner build.
targets:
$default:
builders:
swagger_dart_code_generator:
options:
input_folder: 'lib/swaggers'
output_folder: 'lib/generated_code/'Alternatives
Packages that do the same job and could replace swagger_dart_code_generator.
- swagger_parser
Generate Dart models and HTTP clients from Swagger and OpenAPI schemas.
87Compare - analyzer_buffer
Helper for code generators to write code with import prefixes and default values
65Compare
Works with
Packages commonly used together with swagger_dart_code_generator: ones it builds on, ones built on it, and its own family.
- yamlswagger_dart_code_generator depends on itA Dart library for parsing YAML documents into Dart data structures.
- dart_styleswagger_dart_code_generator depends on itProvides an API and CLI to format Dart source code automatically.
- json_annotationswagger_dart_code_generator depends on itProvides annotations for json_serializable to generate JSON (de)serialization code.
- code_builderswagger_dart_code_generator depends on itA fluent, builder-based library for generating valid Dart code programmatically.
- buildswagger_dart_code_generator depends on itPackage for authoring build_runner compatible code generators.
- markdownswagger_dart_code_generator depends on itA portable Markdown library written in Dart that can parse Markdown into HTML.
- universal_ioswagger_dart_code_generator depends on itCross-platform dart:io implementation with browser support for HttpClient and other APIs
- recaseswagger_dart_code_generator depends on itChanges the case of input text to various conventions.