模仿 Github设计一个博客网站的 API

基本操作

• GET：检索位于指定 URI 处的资源的表示形式。 响应消息的正文包含所请求资源的详细信息。成功的 GET 方法通常返回 HTTP 状态代码 200（正常）。 如果找不到资源，该方法应返回 404（未找到）。
• POST：在指定的 URI 处创建新资源。服务器为新资源分配 URI，并将该 URI 返回给客户端。 在 REST 模型中，我们经常向集合应用 POST 请求。 新资源将添加到集合中。 还可以使用 POST 请求将待处理数据提交到现有资源，且不创建任何新资源。 请求消息的正文将提供新资源的详细信息。 请注意，POST 还用于触发不实际创建资源的操作。
• PUT：在指定的 URI 处创建或替换资源。请求消息的正文指定要创建或更新的资源。客户端指定资源的 URI。请求正文包含资源的完整表示形式。 如果已存在具有此 URI 的资源，则替换该资源。 否则创建新资源（如果服务器支持此操作）。 PUT 请求往往应用到单项资源（例如特定的客户）而不是集合。
• PATCH：对资源执行部分更新。 请求正文包含要应用到资源的一组更改。 客户端指定资源的 URI。这比使用 PUT 更高效，因为客户端只发送更改，而无需发送资源的整个表示形式。
• DELETE：删除位于指定 URI 处的资源。

博客网站的API设计

状态码

HTTP的应答中会使用三位整数的状态码，不同区间的状态码含义如下：

区间	含义
2XX	请求正常处理并返回
3XX	重定向，请求的资源位置发生变化
4XX	客户端发送的请求有错误
5XX	服务器端错误

常用的具体状态码和对应含义如下：

状态码	含义
200	请求成功接收并处理，一般响应中都会有 body
201	请求已完成，并导致了一个或者多个资源被创建
202	请求已经接收并开始处理，但是处理还没有完成
204	请求已经处理完成，但没有信息要返回
301	请求的资源已经永久性地移动到另外一个地方（后续所有的请求都应该直接访问新地址）
304	请求的资源和之前的版本一样，没有发生改变