欢迎访问本项目的 API 参考指南！以下是核心接口说明与使用规范：
🌐 文档导航
📋 接口规范
基础路径
所有 API 请求需以 /api/v1/ 开头，例如：
GET /api/v1/data?format=json
支持方法
| 方法 | 描述 | 示例 |
|---|---|---|
GET |
获取资源 | GET /api/v1/users/123 |
POST |
创建资源 | POST /api/v1/items |
PUT |
更新资源 | PUT /api/v1/settings |
DELETE |
删除资源 | DELETE /api/v1/cache |
响应格式
- 默认返回 JSON 数据
- 可通过
Accept头指定application/xml或text/plain
📖 示例说明
数据查询示例
GET /api/v1/data?query=example
返回：
{
"status": "success",
"data": [/* 示例数据 */]
}
错误处理
- 状态码
404：资源不存在 - 状态码
500：服务器内部错误 - 详细错误信息可通过
error字段获取
📌 扩展阅读
如需了解 API 设计原则，建议参考：API 设计规范文档 📘