# RESTful API 设计规范

良好的 API 设计是高质量服务的基础。本文总结 RESTful API 设计的核心规范。

## 资源命名

- 使用名词复数：`/users` 而非 `/user`
- 小写字母，连字符分隔：`/user-profiles`
- 避免动词：用 HTTP 方法表达操作

## HTTP 方法语义

| 方法 | 用途 | 幂等 |
|------|------|------|
| GET | 获取资源 | 是 |
| POST | 创建资源 | 否 |
| PUT | 更新资源 | 是 |
| DELETE | 删除资源 | 是 |

## 状态码使用

- 200：成功
- 201：创建成功
- 400：请求错误
- 401：未授权
- 404：资源不存在
- 500：服务器错误

## 版本控制

```bash
/api/v1/users
/api/v2/users
```

遵循这些规范可以构建清晰、易用的 API。

<h1 id="heading-1">RESTful API 设计规范</h1>
<p>良好的 API 设计是高质量服务的基础。本文总结 RESTful API 设计的核心规范。</p>
<h2 id="heading-2">资源命名</h2>
<ul>
<li>使用名词复数：<code>/users</code> 而非 <code>/user</code></li>
<li>小写字母，连字符分隔：<code>/user-profiles</code></li>
<li>避免动词：用 HTTP 方法表达操作</li>
</ul>
<h2 id="heading-3">HTTP 方法语义</h2>
<table>
<thead>
<tr>
<th>方法</th>
<th>用途</th>
<th>幂等</th>
</tr>
</thead>
<tbody><tr>
<td>GET</td>
<td>获取资源</td>
<td>是</td>
</tr>
<tr>
<td>POST</td>
<td>创建资源</td>
<td>否</td>
</tr>
<tr>
<td>PUT</td>
<td>更新资源</td>
<td>是</td>
</tr>
<tr>
<td>DELETE</td>
<td>删除资源</td>
<td>是</td>
</tr>
</tbody></table>
<h2 id="heading-4">状态码使用</h2>
<ul>
<li>200：成功</li>
<li>201：创建成功</li>
<li>400：请求错误</li>
<li>401：未授权</li>
<li>404：资源不存在</li>
<li>500：服务器错误</li>
</ul>
<h2 id="heading-5">版本控制</h2>
<pre><code class="language-bash">/api/v1/users
/api/v2/users
</code></pre>
<p>遵循这些规范可以构建清晰、易用的 API。</p>


RESTful API 设计规范 良好的 API 设计是高质量服务的基础。本文总结 RESTful API 设计的核心规范。 资源命名 使用名词复数： /users 而非 /user 小写字母，连字符分隔： /user profiles 避免动词：用 HTTP 方法表达操作 HTTP 方法语义 | 方法 | 用途 | ...

RESTful API 设计规范指南

RESTful API 设计规范

资源命名

HTTP 方法语义

状态码使用

版本控制

评论 0

为你推荐

精选内容

方法	用途	幂等
GET	获取资源	是
POST	创建资源	否
PUT	更新资源	是
DELETE	删除资源	是