插件概览
一个 Flutter/Dart 包,可从 OpenAPI 规范生成客户端 SDK,灵感来自 npm 的 openapi-generator-cli。它可自动化创建类型安全的 Dart 代码以进行 API 交互,减少手动工作量和潜在错误。生成的代码支持多种平台,包括 Android、iOS、Web、macOS、Windows 和 Linux,可在不同环境中实现一致的 API 客户端使用。非常适合依赖 OpenAPI/Swagger 定义来维护其应用程序中强大且更新及时的 API 集成的团队。
适合场景
- 从 OpenAPI 规范自动生成 API 客户端
- 使用类型安全集成 REST API
- 跨平台 Flutter 应用 API 客户端
- 保持 API 合同与后端更改同步
- 减少 API 服务层中的样板代码
主要特点
- 从 OpenAPI 3.x 规范生成 Dart 代码
- 支持多平台输出
- 生成类型安全的 API 模型和服务
- 通过 Flutter pub add 集成
- 使用类似 CLI 的工作流程
适合对象
- 使用 OpenAPI 定义的 API 的 Flutter 开发人员
- 需要自动化 API 客户端更新的团队
- 跨平台需要一致API集成的项目
- 希望减少手动 API 服务编码的开发人员
使用建议
- 需要有效的 OpenAPI 规范文件
- 生成的代码可能需要针对复杂端点进行自定义
- 在 CI/CD 流水线中使用效果最佳,以确保一致性
- 不是运行时库——仅生成源代码