一、URL设计二、状态码三、服务器响应四、参考链接rest风格ul是目前最流行的API设计规范，用于Web数据接口的设计。
其大原则容易掌握，但细节不容易做到。 本文总结了rest风格的设计细节，并介绍了如何设计易于理解和使用的API。
img
一、URL 设计
1.1动词宾语rest风格的核心思想是来自客户端的数据操作命令都是“动词宾语”的结构。 例如，GET /articles指令中，GET是动词，/articles是宾语。
动词通常是五种HTTP方法，对应CRUD操作。
GET :读取(Read ) POST (新建) PUT (更新) PATCH (更新) (通常是部分更新(DELETE )删除)动词根据HTTP规范一律大写。
1.2动词涵盖
某些客户端只能使用两种方法：获取和开机自检。 服务器必须接受开机自检模拟的其他三种方法(PUT、PATCH、DELETE )。
此时，来自客户端的HTTP请求将具有X-HTTP-Method-Override属性，告诉服务器应该使用哪个动词，并涵盖开机自检方法。
POST /api/Person/4 HTTP/1.1
X-HTTP-Method-Override: PUT
在上面的代码中，X-HTTP-Method-Override将此请求的方法指定为上传，而不是开机自检。
1.3宾语必须是名词
宾语是API的URL，是HTTP动词作用的对象。 它应该是名词，不能是动词。 例如，名为/articles的URL是正确的，但下面的URL不是名词，所以都是错误的。
/getallcars/create new car/deleteallredcars 1.4多个URL
URL是名词，应该用复数还是单数？
这没有统一的规定，但常见的操作是读取GET /articles (读取所有文章)这样的一个集合，这里应该明显是多个。
为了统一，建议使用多个URL。 例如，GET /articles/2优于GET /article/2。
1.5避免多级URL
常见的是，因为需要将资源分为多级，所以可以很容易地写多级的URL，比如获取某个作者的某类文章。
GET /authors/12/categories/2
这样的URL不利于扩展，含义也不清楚，在明白意思之前往往需要考虑一段时间。
更好的方法是，级别1以外的级别用查询字符串表示。
GET /authors/12？ categories=2
作为另一个例子，让我们查一下公开的文章。 你可能会设计成下一个网址。
GET /articles/published
查询字符串的写法显然很好。
GET /articles？ published=true
二、状态码
2.1状态代码必须准确对于客户端的每个请求，服务器都必须做出响应。 响应包括两部分： HTTP状态代码和数据。
HTTP状态代码为3位，分为5个类别。
1xx )相关信息2xx )成功操作3xx (重定向4xx )客户端错误5xx )五类服务器错误共包含100多种状态代码，涵盖了大部分可能遇到的情况。 每个状态代码都有标准(或约定的)解释，客户端只需查看状态代码就可以确定发生了什么情况，因此服务必须返回尽可能准确的状态代码。
API不需要1xx状态代码。 介绍其他四种状态代码的准确含义。
2.2 2xx状态代码
200状态代码表示操作成功，但可以使用不同的方法返回更准确的状态代码。
get :200 ok post 3360201 created put :200 ok patch 3360200 ok delete 3360204 no content上的代码将开机自检返回到201状态代码并生成新资源DELETE返回204状态代码，指示资源已不存在。
此外，202 Accepted状态代码表示服务收到请求，但尚未处理，将来将重新处理，通常用于异步操作。 以下是一例。
http/1.1 202已接受
{
' task': {
' href ' : '/API/company/jo B- management/jobs/2130040 '，
' id': '2130040 '
}
}
2.3 3xx状态代码
API不能使用301状态代码(永久重定向)和302状态代码。 临时重定向，307也是这个意思。 )因为它们可以在APP应用程序级别返回，所以浏览器会直接跳转。 API水平在这两种情况下都可以不考虑。
API使用的3xx状态代码主要是303 See Other，表示它引用另一个URL。 还有30
2和307的含义一样，也是"暂时重定向"，区别在于302和307用于GET请求，而303用于POST、PUT和DELETE请求。收到303以后，浏览器不会自动跳转，而会让用户自己决定下一步怎么办。下面是一个例子。HTTP/1.1 303 See Other Location: /api/orders/123452.4 4xx 状态码
4xx状态码表示客户端错误，主要有下面几种。
400 Bad Request：服务器不理解客户端的请求，未做任何处理。
401 Unauthorized：用户未提供身份验证凭据，或者没有通过身份验证。
403 Forbidden：用户通过了身份验证，但是不具有访问资源所需的权限。
404 Not Found：所请求的资源不存在，或不可用。
405 Method Not Allowed：用户已经通过身份验证，但是所用的 HTTP 方法不在他的权限之内。
410 Gone：所请求的资源已从这个地址转移，不再可用。
415 Unsupported Media Type：客户端要求的返回格式不支持。比如，API 只能返回 JSON 格式，但是客户端要求返回 XML 格式。
422 Unprocessable Entity ：客户端上传的附件无法处理，导致请求失败。
429 Too Many Requests：客户端的请求次数超过限额。
2.5 5xx 状态码
5xx状态码表示服务端错误。一般来说，API 不会向用户透露服务器的详细信息，所以只要两个状态码就够了。
500 Internal Server Error：客户端请求有效，服务器处理时发生了意外。
503 Service Unavailable：服务器无法处理请求，一般用于网站维护状态。
三、服务器回应
3.1 不要返回纯本文
API 返回的数据格式，不应该是纯文本，而应该是一个 JSON 对象，因为这样才能返回标准的结构化数据。所以，服务器回应的 HTTP 头的Content-Type属性要设为application/json。
客户端请求时，也要明确告诉服务器，可以接受 JSON 格式，即请求的 HTTP 头的ACCEPT属性也要设成application/json。下面是一个例子。
GET /orders/2 HTTP/1.1 Accept: application/json3.2 发生错误时，不要返回 200 状态码
有一种不恰当的做法是，即使发生错误，也返回200状态码，把错误信息放在数据体里面，就像下面这样。
HTTP/1.1 200 OK Content-Type: application/json { "status": "failure", "data": { "error": "Expected at least two items in list." } }上面代码中，解析数据体以后，才能得知操作失败。
这张做法实际上取消了状态码，这是完全不可取的。正确的做法是，状态码反映发生的错误，具体的错误信息放在数据体里面返回。下面是一个例子。
HTTP/1.1 400 Bad Request Content-Type: application/json { "error": "Invalid payoad.", "detail": { "surname": "This field is required." } }3.3 提供链接
API 的使用者未必知道，URL 是怎么设计的。一个解决方法就是，在回应中，给出相关链接，便于下一步操作。这样的话，用户只要记住一个 URL，就可以发现其他的 URL。这种方法叫做 HATEOAS。
举例来说，GitHub 的 API 都在 api.github.com 这个域名。访问它，就可以得到其他 URL。
{ ... "feeds_url": "https://api.github.com/feeds", "followers_url": "https://api.github.com/user/followers", "following_url": "https://api.github.com/user/following{/target}", "gists_url": "https://api.github.com/gists{/gist_id}", "hub_url": "https://api.github.com/hub", ... }上面的回应中，挑一个 URL 访问，又可以得到别的 URL。对于用户来说，不需要记住 URL 设计，只要从 api.github.com 一步步查找就可以了。
HATEOAS 的格式没有统一规定，上面例子中，GitHub 将它们与其他属性放在一起。更好的做法应该是，将相关链接与其他属性分开。
HTTP/1.1 200 OK Content-Type: application/json { "status": "In progress", "links": {[ { "rel":"cancel", "method": "delete", "href":"/api/status/12345" } , { "rel":"edit", "method": "put", "href":"/api/status/12345" } ]} }四、参考链接
RESTful API Design: 13 Best Practices to Make Your Users Happy, by Florimond MancaAPI design, by MicroSoft Azure（完）
来源：http://t.cn/EhVCDAW
搜索微信号（ID：芋道源码），可以获得各种 Java 源码解析。
并且，回复【书籍】后，可以领取笔者推荐的各种 Java 从入门到架构的书籍。
来吧，骚年~