wangyang
/
swagger_generator_flutter
1
0
Fork 0
Code Pull Requests Actions Releases Activity
51 Commits 2 Branches 18 Tags 764 KiB
Commit Graph

13 Commits

Author SHA1 Message Date
Max 111375b749 feat: 实现枚举配置文件映射和UNKNOWN枚举值 
✨ 新功能
- 支持通过 generator_config.yaml 配置枚举键名映射
- 实现三级优先级：配置文件 > x-enum-varnames > 智能生成
- 自动为所有枚举添加 UNKNOWN 值（整数用-9999，字符串用'UNKNOWN'）
- fromValue 方法改为返回 UNKNOWN 而不是抛异常，提供更好的容错性

🔧 核心修改
- lib/core/config_repository.dart: 添加 EnumKeyMapping 和 enumKeyMappings 解析
- lib/core/config.dart: 暴露枚举映射配置
- lib/pipeline/generate/impl/model/model_content_builders.dart: 实现三级优先级枚举生成和 UNKNOWN 值
- lib/core/models/api_schema.dart: 支持 x-enum-varnames 和 x-enum-descriptions 扩展字段
- lib/pipeline/generate/impl/retrofit_api/api_return_types.dart: 修复 BasePageResult 包裹逻辑

📚 文档更新
- 新增 ENUM_QUICK_REFERENCE.md: 快速参考指南
- 新增 ENUM_KEY_NAMES_USAGE.md: 详细使用指南
- 新增 ENUM_CONFIG_MAPPING_SUMMARY.md: 功能实现总结
- 新增 ENUM_KEY_NAMES_PROPOSAL.md: 技术提案
- 更新 README.md 和 CHANGELOG.md
- 更新 generator_config.template.yaml 添加配置示例

📦 示例文件
- example/swagger_enum_example.json: Swagger 扩展字段示例
- example/enum_config_mapping_example.yaml: 完整配置示例

✅ 测试验证
- test/pagination_wrapping_test.dart: BasePageResult 包裹测试
- 功能已通过实际生成测试验证

🎯 使用场景
1. 后端支持 OpenAPI 扩展 → 使用 x-enum-varnames
2. 后端不支持扩展 → 使用配置文件映射
3. 需要覆盖 Swagger → 使用配置文件映射
4. 快速原型开发 → 使用智能生成
 2025-11-24 10:47:17 +08:00
Max 48863c6255 重构与迁移： 
1) 配置访问全量迁移
- 移除 ConfigLoader，统一切换为 ConfigRepository（保持 SwaggerConfig 静态 API 向后兼容）
- TemplateRenderer/TemplateLoader/GOS/API 模板数据/命令层全面替换，避免重复 I/O（懒加载缓存）
- 新增迁移文档：docs/MIGRATION_CONFIG_LOADER.md

2) StringUtils 职责拆分与聚合导出
- 新增 utils/string_utils/text_cleaner.dart（文本清理/转义/截断）
- 保留 utils/string_utils.dart 作为统一导出（NamingConverter/TemplateService/TextCleaner）
- 新增 STRING_UTILS_REFACTOR_SUMMARY.md，总结重构内容与使用示例

3) 文档与概览更新
- 更新 docs/PROJECT_OVERVIEW.md：最新架构图、模块职责、生成流程与近期重构
- 更新 check_list.md：标记 string_utils/error_reporter 重构完成

4) 质量与兼容性
- dart analyze：0 error / 0 warning（仅 info 提示）
- dart test：全部通过（203/203）
- 保持命令与生成行为不变（无破坏性改动）
 2025-11-22 18:18:06 +08:00
Max f2e48277ea feat: update 2025-11-21 22:27:01 +08:00
Max 69aad6bda1 chore: release 3.0.0 – remove OptimizedRetrofitGenerator; consolidate on RetrofitApiGenerator; update docs and examples; fix QRCodeApi reference; improve ApiClient class-name extraction; bump version to 3.0.0; update CHANGELOG 2025-11-21 18:10:37 +08:00
Max ca57ceb354 update 2025-11-05 18:38:05 +08:00
Max 5f6c87ef67 feat: 添加文件头配置和文件跳过功能 
主要变更:
- ✨ 新增文件头模板配置功能
  - 支持通过 templates.file_header 自定义文件头格式
  - 支持模板变量: {fileName}, {fileType}, {swaggerUrl}, {generatorName}, {author}, {copyright}
  - 自动从 generator 配置读取生成器信息

- ✨ 新增文件跳过功能
  - 支持 ignored_directories 配置，跳过指定目录下的所有文件
  - 支持 ignored_files 配置，支持精确匹配和通配符匹配（*prefix, suffix*, *pattern*）
  - 在所有文件生成点添加跳过检查

- ✨ 新增 ConfigLoader 配置加载器
  - 统一管理配置文件读取
  - 支持 YAML 配置解析
  - 提供配置缓存机制

- 📝 更新配置文件
  - 添加 templates 配置部分
  - 添加 output.ignored_directories 和 output.ignored_files 配置
  - 完善配置示例和注释

- 📚 添加文档
  - FILE_HEADER_CONFIGURATION.md: 文件头配置功能文档
  - CODE_REVIEW_REPORT.md: 代码审核报告
  - 更新示例项目配置

- 🗑️ 清理代码
  - 移除 ApiPaths 生成功能
  - 删除旧的示例文件
  - 精简项目结构

- 🔧 优化依赖
  - 移除内部项目依赖（learning_officer_oa）
  - 更新依赖版本
  - 支持作为 dev_dependency 使用
 2025-11-05 16:59:27 +08:00
Max 12ed10e221 feat: 增强代码生成器 - 模型分类、目录优化与多版本API支持 
主要改进：
1. 响应模型 List 默认值
   - 为响应模型的 List 类型添加 @JsonKey(defaultValue: [])
   - 请求模型不添加默认值，避免影响后端接收

2. ModelUsageType 模型分类
   - 新增 ModelUsageType 枚举（request/response/common/unknown）
   - 通过解析 Swagger 文档的 paths 自动判定模型用途
   - 更准确地区分请求参数和返回结果

3. api_models 目录结构优化
   - enums/ - 枚举类型
   - request/ - 请求模型
   - result/ - 响应模型
   - parameters/ - 查询参数类
   - 每个子目录生成 index.dart 便于导入

4. 导入策略优化
   - API 文件统一使用 import '../../api_models/index.dart'
   - 利用 Dart tree-shaking，不影响应用大小
   - 简化导入管理，提高可维护性

5. 多版本 API 支持
   - 支持多个 Swagger 文档 URL（v1/v2/v3...）
   - API 文件按版本分目录（api/v1/、api/v2/）
   - V1 版本类名不加后缀（如 MobileManagerApi）
   - V2+ 版本类名添加版本号后缀（如 MobileManagerApiV2）
   - 每个版本目录生成 index.dart
   - ApiClient 提供显式版本访问器

配置变更：
- SwaggerConfig.swaggerJsonUrls 支持多个 URL
 2025-11-03 11:06:35 +08:00
Max 06e2b9165c feat: List 增加默认值 2025-10-29 19:44:18 +08:00
Max e6030aea96 feat: update 2025-10-11 17:00:37 +08:00
Max a12bf7e618 feat: 恢复代码 2025-07-24 10:44:25 +08:00
Max 547a6c7f16 Revert "feat: 优化项目升级为2.0 严格执行3.0 swagger 标准" 
This reverts commit 0fc76544ff.
 2025-07-24 10:42:22 +08:00
Max 0fc76544ff feat: 优化项目升级为2.0 严格执行3.0 swagger 标准 2025-07-24 10:38:02 +08:00
Max 5c9d2c8d36 init 2025-07-13 07:01:51 +08:00