WuYongJie 473176997a docs: 完成API文档编写(任务26)
创建完整的API文档:
- 模板管理API(5个接口)
  * 获取模板列表
  * 获取模板详情(含使用统计)
  * 创建模板(含验证规则)
  * 更新模板(含版本控制)
  * 删除模板(含使用检查)

- 模板验证API
  * 内置模板验证逻辑
  * 自定义模板验证逻辑
  * 内置模板列表

- 字段池管理API(2个接口)
  * 获取字段池列表
  * 同步字段池

- 分类字段管理API
  * 获取分类管理字段

- 错误代码规范
  * 统一错误响应格式
  * 常见错误代码说明

- 性能指标
  * 响应时间目标
  * 数据库优化说明(20+个索引)

- 最佳实践
  * 版本控制使用方法
  * 错误处理示例
  * 字段验证示例
  * 性能优化建议

文档位置:docs/api/template-system-api.md
2025-12-13 15:42:39 +08:00
..

文档索引

本目录集中存放部署、运维与问题排查资料,按主题分组,便于快速查找。

快速入口

  • 部署流程:guides/安全部署指南.md、guides/安全部署说明.md
  • 团队协作:WORKFLOW.md
  • 更新记录:guides/更新说明.md、reports/DEPLOYMENT_REPORT_20251028.md
  • 故障排查:guides/上传问题完整解决方案.md、reports/NETWORK_FIX_REPORT.md
  • 网络/安全:guides/FRP服务器诊断修复报告.md、guides/SSH安全评估报告.md

目录结构

  • guides/:正式的操作指南与流程文档
  • reports/:部署、优化、故障排查等报告
  • chats/:沟通记录与会议纪要
  • 其它 .md 文件:历史材料、需求背景和补充说明

使用建议

  1. 先阅读 guides/ 获取标准流程,再按需查看对应 reports/。
  2. 文档使用 UTF-8 编码,推荐在支持中文的编辑器中打开。
  3. 更新或新增文档时,请在此文件的“快速入口”中补充链接,方便他人定位。