# 更新Swagger API文档 ## 1. 分析当前状态 * Swagger文档位于 `/root/dns/static/api/js/index.js` 中 * 项目使用Go语言开发,HTTP API端点在 `/root/dns/http/server.go` 中定义 * 当前swagger文档缺少一些API端点和正确的描述 ## 2. 需要更新的内容 ### 2.1 添加缺少的API端点 * `/api/login` - 登录API * `/api/logout` - 注销API * `/api/change-password` - 修改密码API * `/api/query` - DNS查询API * `/api/status` - 系统状态API * `/api/config` - 配置管理API * `/api/config/restart` - 重启服务API * `/api/logs/stats` - 日志统计API * `/api/logs/query` - 日志查询API * `/api/logs/count` - 日志数量API ### 2.2 更新现有端点描述 * `/api/stats` - 添加DNSSEC相关字段描述 * `/api/shield` - 更新为与实际实现匹配 * `/api/shield/blacklists` - 确保包含所有HTTP方法 * `/api/shield/hosts` - 确保包含所有HTTP方法 * `/api/shield/localrules` - 确保包含所有HTTP方法 ### 2.3 修正现有端点的响应格式 * 修正 `/api/hourly-stats`、`/api/daily-stats` 和 `/api/monthly-stats` 的响应格式 * 修正 `/api/shield` 的响应格式 ## 3. 实施步骤 1. 读取当前swagger文档 2. 针对每个需要更新的端点,修改或添加相应的swagger定义 3. 确保所有端点的HTTP方法、参数、响应格式都正确 4. 测试swagger文档是否能正常加载和显示 ## 4. 预期结果 * 所有API端点都在swagger文档中正确描述 * 每个端点的HTTP方法、参数、响应格式都准确 * swagger文档能正常加载和显示 * 开发者可以通过swagger文档了解和使用所有API端点