插件概览
一个 Flutter/Dart 包,使用 Freezed 生成不可变数据类,使用 Dio 进行 HTTP 请求,从 OpenAPI 规范生成类型安全的模型和 API 客户端。它通过自动生成针对 API 结构的 Dart 代码,简化后端集成,减少样板代码并提高可维护性。适用于依赖通过 OpenAPI(Swagger)定义的 REST API 的项目,确保 API 合同与客户端实现之间的一致性。
适合场景
- 从 OpenAPI 规范自动生成 API 客户端
- 使用 Freezed 创建不可变的数据模型
- 简化 Flutter 应用中的 REST API 集成
- 保持 API 和客户端代码之间的同步
- 使用共享 API 逻辑支持多平台应用
主要特点
- 从 OpenAPI 文档生成代码
- 使用 Freezed 的不可变模型
- 基于 Dio 的 HTTP 客户端集成
- 类型安全的 API 端点
- 可自定义的代码生成模板
适合对象
- 使用 OpenAPI 定义的 API 的 Flutter 开发人员
- 需要一致的 API 客户端生成的团队
- 需要不可变数据模型的项目
- 针对多个平台的应用
- 希望减少手动 API 代码的开发人员
使用建议
- 需要一个 OpenAPI 规范文件
- 生成的代码在更新时必须谨慎管理
- 仅限 OpenAPI 2.0 和 3.x 格式
- 对于复杂架构,可能需要手动配置
- 在 CI/CD 流水线中使用效果最佳,可实现一致的再生
