let5sne 3949676ba7 📚 添加完整的 RESTful API 文档 ...

新增文档：
1. RESTFUL_API_DOCUMENTATION.md (1000+ 行)
   - OpenAI 风格的完整 API 文档
   - 详细的认证说明
   - 所有端点的完整说明
   - 多语言示例代码（Python/JS/PHP/Go/cURL）
   - 错误处理和最佳实践
   - 性能优化建议
   - 安全建议和代码示例

2. openapi.yaml (700+ 行)
   - OpenAPI 3.0.3 规范文件
   - 完整的 API 定义
   - 可被 Swagger UI/Redoc 自动渲染
   - 包含所有请求/响应示例
   - 详细的错误代码说明
   - 限流规则定义
   - 多语言代码示例

3. IOPaint_API.postman_collection.json
   - Postman Collection V2.1
   - 包含所有 API 端点
   - 预配置的测试脚本
   - 示例请求和响应
   - 环境变量配置
   - 一键导入即可测试

特点：
✅ 符合 OpenAPI 标准
✅ 专业的文档格式
✅ 丰富的代码示例
✅ 完整的错误处理说明
✅ 最佳实践指导
✅ 可直接用于生产环境

使用方式：
- Markdown 文档：直接阅读
- OpenAPI YAML：导入 Swagger UI 或 Redoc
- Postman Collection：导入 Postman 进行测试

🔧 Generated with Claude Code

2025-11-28 17:53:23 +00:00

14 KiB

Raw Blame History

View Raw