androidapachebackendcentoscommandcomposercrontabcurldesigndevelopdockerelasticfinancingfirewallfrontendgitgolanghybridiisiptablesjavajenkinskuberneteslaravelluamacmemcachemigrationmongodbmysqlnginxnodejsofficeopensslperformancephpredisregexprestfulsecurityshellsnippetsshstartupteamtraintravelunitvmwarevsftpwindowsworkwwwyaf

Restful 接口规范

约定

GET(Select):查询
POST(Create):创建
PUT(Replace):替换
PATCH(Update):更新
DELETE(Remove):删除

SSL

Restful API一定要使用 HTTPS 传输

JSON

目前,JSON 作为唯一的交互格式

命名规则

snake

鉴权

restful API 是无状态的也就是说用户请求的鉴权和 cookie 以及 session 无关,每一次请求都应该包含鉴权证明。
统一使用 Token 或者 OAuth2.0 认证。

示例

电影

GET /movies 
POST /movies 
GET /movies/12 
PUT /movies/12 
PATCH /movies/12 
DELETE /movies/12

电影评论

GET /movies/12/comments 
POST /movies/12/comments 
GET /movies/12/comments/5
PUT /moviess/12/comments/5 
PATCH /movies/12/comments/5 
DELETE /movies/12/comments/5

过滤,查询,排序

GET https://api.com/movies?state=open&search=funny&sort=-priority,created_at

状态码

1×× Informational

100 Continue
101 Switching Protocols
102 Processing

2×× Success

200 OK
201 Created
202 Accepted
203 Non-authoritative Information
204 No Content
205 Reset Content
206 Partial Content
207 Multi-Status
208 Already Reported
226 IM Used

3×× Redirection

300 Multiple Choices
301 Moved Permanently
302 Found
303 See Other
304 Not Modified
305 Use Proxy
307 Temporary Redirect
308 Permanent Redirect

4×× Client Error

400 Bad Request
401 Unauthorized
402 Payment Required
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Not Acceptable
407 Proxy Authentication Required
408 Request Timeout
409 Conflict
410 Gone
411 Length Required
412 Precondition Failed
413 Payload Too Large
414 Request-URI Too Long
415 Unsupported Media Type
416 Requested Range Not Satisfiable
417 Expectation Failed
418 I'm a teapot
421 Misdirected Request
422 Unprocessable Entity
423 Locked
424 Failed Dependency
426 Upgrade Required
428 Precondition Required
429 Too Many Requests
431 Request Header Fields Too Large
444 Connection Closed Without Response
451 Unavailable For Legal Reasons
499 Client Closed Request

5×× Server Error

500 Internal Server Error
501 Not Implemented
502 Bad Gateway
503 Service Unavailable
504 Gateway Timeout
505 HTTP Version Not Supported
506 Variant Also Negotiates
507 Insufficient Storage
508 Loop Detected
510 Not Extended
511 Network Authentication Required
599 Network Connect Timeout Error

参考内容