更新文档
模型 Schema (model-schema.md
)
- 更新了字段类型定义,移除了过时的ID类型
- 添加了新的字段类型:Time、JSON、Enum、Relation
- 更新了字段属性定义,添加了identity、modelName等属性
- 添加了索引定义的详细说明
- 更新了示例,使用最新的JSON格式
- 添加了默认值支持的说明
- 新增: 完善了IDL对象配置章节,包含完整的语法规范和示例
查询条件 (condition.md
)
- 重新组织了文档结构,按操作符类型分类
- 添加了完整的操作符表格和示例
- 更新了查询示例,使用更实用的场景
- 添加了在API中使用的说明
- 添加了注意事项和最佳实践
- 添加了高级用法:关联查询、嵌套查询、空值查询
API 介绍 (index.md
)
- 完全重写了介绍页面
- 添加了主要功能概述
- 添加了API基础信息(认证、路径、响应格式)
- 添加了快速开始指南
- 添加了相关文档链接
组件文档
- flexmodel-core - 更新了功能特性,添加了查询构建器、表达式构建、模型定义等核心功能说明
- flexmodel-graphql - 完全重写,添加了完整的使用指南、示例和最佳实践
技术改进
- 基于最新的代码实现更新了所有文档
- 统一了文档格式和风格
- 添加了丰富的代码示例
- 改进了文档的可读性和实用性
- 添加了最佳实践和性能优化建议
移除内容
- 移除了过时的字段类型(如ID、Text)
- 移除了不再支持的配置选项
- 清理了过时的示例代码
2024-01-XX - IDL文档完善
IDL对象配置章节
- 新增: 完整的IDL语法规范说明
- 新增: 字段类型和修饰符详细说明
- 新增: 注解系统完整文档(@id、@default、@relation、@index等)
- 新增: 模型定义和枚举定义示例
- 新增: 关联关系和索引定义语法
- 新增: 与JSON格式的对比分析
- 新增: IDL最佳实践指南
IDL特性
- 支持类似TypeScript的简洁语法
- 原生支持注释(单行和多行)
- 强类型系统,提供更好的开发体验
- 丰富的注解系统,支持复杂的模型定义
- 支持关联关系、索引、默认值等高级特性
2023-XX-XX - 初始版本
- 创建了基础的API文档结构
- 添加了模型Schema和查询条件的基础说明
- 添加了组件文档的基础内容