47 lines
845 B
Markdown
47 lines
845 B
Markdown
# REST API 设计规范
|
|
|
|
> **文档版本**: v1.0.0
|
|
> **创建日期**: 2026-05-25
|
|
> **最后更新**: 2026-05-25
|
|
> **文档作者**: 后端开发
|
|
> **文档状态**: 草稿
|
|
|
|
## 目录
|
|
|
|
- [一、URL 设计](#一url-设计)
|
|
- [二、HTTP 方法](#二http-方法)
|
|
- [三、响应格式](#三响应格式)
|
|
|
|
---
|
|
|
|
## 一、URL 设计
|
|
|
|
- 使用名词复数：`/users`, `/orders`
|
|
- 使用小写和连字符：`/user-profiles`
|
|
- 版本号在路径中：`/api/v1/users`
|
|
|
|
## 二、HTTP 方法
|
|
|
|
| 方法 | 用途 |
|
|
|------|------|
|
|
| GET | 获取资源 |
|
|
| POST | 创建资源 |
|
|
| PUT | 完整更新资源 |
|
|
| PATCH | 部分更新资源 |
|
|
| DELETE | 删除资源 |
|
|
|
|
## 三、响应格式
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"message": "success",
|
|
"data": {}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
> **文档维护**: 本文档由后端开发维护
|
|
> **最后更新**: 2026-05-25
|