{"id":8924,"date":"2023-09-12T17:41:40","date_gmt":"2023-09-12T09:41:40","guid":{"rendered":"\/?p=8924"},"modified":"2023-09-12T17:42:30","modified_gmt":"2023-09-12T09:42:30","slug":"%e4%bb%80%e4%b9%88%e6%98%afrestful","status":"publish","type":"post","link":"\/?p=8924","title":{"rendered":"\u4ec0\u4e48\u662fRESTful"},"content":{"rendered":"

RESTful\u6982\u8ff0<\/h1>\n

\u4e3a\u4ec0\u4e48\u8981\u4f7f\u7528RESTful\u67b6\u6784<\/h2>\n

REST \u662f Representational State Transfer \u7684\u7f29\u5199\uff0c\u5982\u679c\u4e00\u4e2a\u67b6\u6784\u7b26\u5408 REST \u539f\u5219\uff0c\u5c31\u79f0\u5b83\u4e3a RESTful \u67b6\u6784<\/p>\n

RESTful \u67b6\u6784\u53ef\u4ee5\u5145\u5206\u7684\u5229\u7528 HTTP \u534f\u8bae\u7684\u5404\u79cd\u529f\u80fd\uff0c\u662f HTTP \u534f\u8bae\u7684\u6700\u4f73\u5b9e\u8df5<\/p>\n

RESTful API \u662f\u4e00\u79cd\u8f6f\u4ef6\u67b6\u6784\u98ce\u683c\u3001\u8bbe\u8ba1\u98ce\u683c\uff0c\u53ef\u4ee5\u8ba9\u8f6f\u4ef6\u66f4\u52a0\u6e05\u6670\uff0c\u66f4\u7b80\u6d01\uff0c\u66f4\u6709\u5c42\u6b21\uff0c\u53ef\u7ef4\u62a4\u6027\u66f4\u597d<\/p>\n

RESTful API \u8bf7\u6c42\u8bbe\u8ba1<\/h2>\n

\u8bf7\u6c42 = \u52a8\u8bcd + \u5bbe\u8bed<\/strong><\/p>\n

\u52a8\u8bcd \u4f7f\u7528\u4e94\u79cd HTTP \u65b9\u6cd5\uff0c\u5bf9\u5e94 CRUD \u64cd\u4f5c\u3002<\/p>\n

\u5bbe\u8bed URL \u5e94\u8be5\u5168\u90e8\u4f7f\u7528\u540d\u8bcd\u590d\u6570\uff0c\u53ef\u4ee5\u6709\u4f8b\u5916\uff0c\u6bd4\u5982\u641c\u7d22\u53ef\u4ee5\u4f7f\u7528\u66f4\u52a0\u76f4\u89c2\u7684 search \u3002<\/p>\n

\u8fc7\u6ee4\u4fe1\u606f\uff08Filtering\uff09 \u5982\u679c\u8bb0\u5f55\u6570\u91cf\u5f88\u591a\uff0cAPI\u5e94\u8be5\u63d0\u4f9b\u53c2\u6570\uff0c\u8fc7\u6ee4\u8fd4\u56de\u7ed3\u679c\u3002 ?limit=10 \u6307\u5b9a\u8fd4\u56de\u8bb0\u5f55\u7684\u6570\u91cf ?offset=10 \u6307\u5b9a\u8fd4\u56de\u8bb0\u5f55\u7684\u5f00\u59cb\u4f4d\u7f6e<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
<\/th>\n<\/th>\n<\/th>\n<\/tr>\n<\/thead>\n
GET<\/td>\n\/zoos<\/td>\n\u5217\u51fa\u6240\u6709\u52a8\u7269\u56ed<\/td>\n<\/tr>\n
POST<\/td>\n\/zoos<\/td>\n\u65b0\u5efa\u4e00\u4e2a\u52a8\u7269\u56ed<\/td>\n<\/tr>\n
GET<\/td>\n\/zoos\/:id<\/td>\n\u83b7\u53d6\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u4fe1\u606f<\/td>\n<\/tr>\n
PUT<\/td>\n\/zoos\/:id<\/td>\n\u66f4\u65b0\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u5168\u90e8\u4fe1\u606f<\/td>\n<\/tr>\n
PATCH<\/td>\n\/zoos\/:id<\/td>\n\u66f4\u65b0\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u90e8\u5206\u4fe1\u606f<\/td>\n<\/tr>\n
DELETE<\/td>\n\/zoos\/:id<\/td>\n\u5220\u9664\u67d0\u4e2a\u52a8\u7269\u56ed<\/td>\n<\/tr>\n
GET<\/td>\n\/zoos\/:id\/animals<\/td>\n\u5217\u51fa\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u6240\u6709\u52a8\u7269<\/td>\n<\/tr>\n
DELETE<\/td>\n\/zoos\/:id\/animals\/:id<\/td>\n\u5220\u9664\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u6307\u5b9a\u52a8\u7269<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

RESTful API \u54cd\u5e94\u8bbe\u8ba1<\/h2>\n

\u4f7f\u7528 HTTP \u7684\u72b6\u6001\u7801<\/strong><\/p>\n

\u5ba2\u6237\u7aef\u7684\u6bcf\u4e00\u6b21\u8bf7\u6c42\uff0c\u670d\u52a1\u5668\u90fd\u5fc5\u987b\u7ed9\u51fa\u56de\u5e94\u3002\u56de\u5e94\u5305\u62ec HTTP \u72b6\u6001\u7801\u548c\u6570\u636e\u4e24\u90e8\u5206\u3002<\/p>\n

\u4e94\u5927\u7c7b\u72b6\u6001\u7801\uff0c\u603b\u5171100\u591a\u79cd\uff0c\u8986\u76d6\u4e86\u7edd\u5927\u90e8\u5206\u53ef\u80fd\u9047\u5230\u7684\u60c5\u51b5\u3002\u6bcf\u4e00\u79cd\u72b6\u6001\u7801\u90fd\u6709\u7ea6\u5b9a\u7684\u89e3\u91ca\uff0c\u5ba2\u6237\u7aef\u53ea\u9700\u67e5\u770b\u72b6\u6001\u7801\uff0c\u5c31\u53ef\u4ee5\u5224\u65ad\u51fa\u53d1\u751f\u4e86\u4ec0\u4e48\u60c5\u51b5\u3002API \u4e0d\u9700\u89811xx\u72b6\u6001\u7801\u3002<\/p>\n\n\n\n\n\n\n\n\n\n
<\/th>\n<\/th>\n<\/tr>\n<\/thead>\n
1xx<\/td>\n\u76f8\u5173\u4fe1\u606f<\/td>\n<\/tr>\n
2xx<\/td>\n\u64cd\u4f5c\u6210\u529f<\/td>\n<\/tr>\n
3xx<\/td>\n\u91cd\u5b9a\u5411<\/td>\n<\/tr>\n
4xx<\/td>\n\u5ba2\u6237\u7aef\u9519\u8bef<\/td>\n<\/tr>\n
5xx<\/td>\n\u670d\u52a1\u5668\u9519\u8bef<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u670d\u52a1\u5668\u56de\u5e94\u6570\u636e<\/strong><\/p>\n

\u5ba2\u6237\u7aef\u8bf7\u6c42\u65f6\uff0c\u8981\u660e\u786e\u544a\u8bc9\u670d\u52a1\u5668\uff0c\u63a5\u53d7 JSON \u683c\u5f0f\uff0c\u8bf7\u6c42\u7684 HTTP \u5934\u7684 ACCEPT \u5c5e\u6027\u8981\u8bbe\u6210 application\/json<\/p>\n

\u670d\u52a1\u7aef\u8fd4\u56de\u7684\u6570\u636e\uff0c\u4e0d\u5e94\u8be5\u662f\u7eaf\u6587\u672c\uff0c\u800c\u5e94\u8be5\u662f\u4e00\u4e2a JSON \u5bf9\u8c61\u3002\u670d\u52a1\u5668\u56de\u5e94\u7684 HTTP \u5934\u7684 Content-Type \u5c5e\u6027\u8981\u8bbe\u4e3a application\/json<\/p>\n

\u9519\u8bef\u5904\u7406 \u5982\u679c\u72b6\u6001\u7801\u662f4xx\uff0c\u5c31\u5e94\u8be5\u5411\u7528\u6237\u8fd4\u56de\u51fa\u9519\u4fe1\u606f\u3002\u4e00\u822c\u6765\u8bf4\uff0c\u8fd4\u56de\u7684\u4fe1\u606f\u4e2d\u5c06 error \u4f5c\u4e3a\u952e\u540d\uff0c\u51fa\u9519\u4fe1\u606f\u4f5c\u4e3a\u952e\u503c\u5373\u53ef\u3002 {error: "Invalid API key"}<\/p>\n

\u8ba4\u8bc1 RESTful API \u5e94\u8be5\u662f\u65e0\u72b6\u6001\uff0c\u6bcf\u4e2a\u8bf7\u6c42\u5e94\u8be5\u5e26\u6709\u4e00\u4e9b\u8ba4\u8bc1\u51ed\u8bc1\u3002\u63a8\u8350\u4f7f\u7528 JWT \u8ba4\u8bc1\uff0c\u5e76\u4e14\u4f7f\u7528 SSL<\/p>\n

Hypermedia \u5373\u8fd4\u56de\u7ed3\u679c\u4e2d\u63d0\u4f9b\u94fe\u63a5\uff0c\u8fde\u5411\u5176\u4ed6API\u65b9\u6cd5\uff0c\u4f7f\u5f97\u7528\u6237\u4e0d\u67e5\u6587\u6863\uff0c\u4e5f\u77e5\u9053\u4e0b\u4e00\u6b65\u5e94\u8be5\u505a\u4ec0\u4e48<\/p>\n

API\u8bf7\u6c42<\/h1>\n

1. HTTP \u52a8\u8bcd<\/h3>\n
GET\uff1a   \u8bfb\u53d6\uff08Read\uff09\nPOST\uff1a  \u65b0\u5efa\uff08Create\uff09\nPUT\uff1a   \u66f4\u65b0\uff08Update\uff09\nPATCH\uff1a \u66f4\u65b0\uff08Update\uff09\uff0c\u901a\u5e38\u662f\u90e8\u5206\u66f4\u65b0\nDELETE\uff1a\u5220\u9664\uff08Delete\uff09<\/code><\/pre>\n
2. URL\uff08\u5bbe\u8bed\uff09\u5fc5\u987b\u662f\u540d\u8bcd<\/h3>\n
\u5bbe\u8bed\u5c31\u662f API \u7684 URL\uff0c\u662f HTTP \u52a8\u8bcd\u4f5c\u7528\u7684\u5bf9\u8c61\u3002\u5b83\u5e94\u8be5\u662f\u540d\u8bcd\uff0c\u4e0d\u80fd\u662f\u52a8\u8bcd\u3002\u6bd4\u5982\uff0c\/articles\u8fd9\u4e2a URL \u5c31\u662f\u6b63\u786e\u7684\uff0c\u800c\u4e0b\u9762\u7684 URL \u4e0d\u662f\u540d\u8bcd\uff0c\u6240\u4ee5\u90fd\u662f\u9519\u8bef\u7684\u3002<\/p>\n
\/getAllCars\n\/createNewCar\n\/deleteAllRedCars<\/code><\/pre>\n
\u65e2\u7136 URL \u662f\u540d\u8bcd\uff0c\u4e3a\u4e86\u7edf\u4e00\u8d77\u89c1\uff0c\u5efa\u8bae\u90fd\u4f7f\u7528\u590d\u6570\u3002<\/p>\n
3. \u4e3e\u4e2a\u4f8b\u5b50<\/h3>\n
GET    \/zoos\uff1a\u5217\u51fa\u6240\u6709\u52a8\u7269\u56ed\nPOST   \/zoos\uff1a\u65b0\u5efa\u4e00\u4e2a\u52a8\u7269\u56ed\nGET    \/zoos\/ID\uff1a\u83b7\u53d6\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u4fe1\u606f\nPUT    \/zoos\/ID\uff1a\u66f4\u65b0\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u4fe1\u606f\uff08\u63d0\u4f9b\u8be5\u52a8\u7269\u56ed\u7684\u5168\u90e8\u4fe1\u606f\uff09\nPATCH  \/zoos\/ID\uff1a\u66f4\u65b0\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u4fe1\u606f\uff08\u63d0\u4f9b\u8be5\u52a8\u7269\u56ed\u7684\u90e8\u5206\u4fe1\u606f\uff09\nDELETE \/zoos\/ID\uff1a\u5220\u9664\u67d0\u4e2a\u52a8\u7269\u56ed\nGET    \/zoos\/ID\/animals\uff1a\u5217\u51fa\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u6240\u6709\u52a8\u7269\nDELETE \/zoos\/ID\/animals\/ID\uff1a\u5220\u9664\u67d0\u4e2a\u6307\u5b9a\u52a8\u7269\u56ed\u7684\u6307\u5b9a\u52a8\u7269<\/code><\/pre>\n
4. \u8fc7\u6ee4\u4fe1\u606f\uff08Filtering\uff09<\/h3>\n
\u5982\u679c\u8bb0\u5f55\u6570\u91cf\u5f88\u591a\uff0c\u670d\u52a1\u5668\u4e0d\u53ef\u80fd\u90fd\u5c06\u5b83\u4eec\u8fd4\u56de\u7ed9\u7528\u6237\u3002API\u5e94\u8be5\u63d0\u4f9b\u53c2\u6570\uff0c\u8fc7\u6ee4\u8fd4\u56de\u7ed3\u679c\u3002<\/p>\n
\u4e0b\u9762\u662f\u4e00\u4e9b\u5e38\u89c1\u7684\u53c2\u6570\u3002<\/p>\n
?limit=10\uff1a\u6307\u5b9a\u8fd4\u56de\u8bb0\u5f55\u7684\u6570\u91cf\n?offset=10\uff1a\u6307\u5b9a\u8fd4\u56de\u8bb0\u5f55\u7684\u5f00\u59cb\u4f4d\u7f6e\u3002\n?page=2&per_page=100\uff1a\u6307\u5b9a\u7b2c\u51e0\u9875\uff0c\u4ee5\u53ca\u6bcf\u9875\u7684\u8bb0\u5f55\u6570\u3002\n?sortby=name&order=asc\uff1a\u6307\u5b9a\u8fd4\u56de\u7ed3\u679c\u6309\u7167\u54ea\u4e2a\u5c5e\u6027\u6392\u5e8f\uff0c\u4ee5\u53ca\u6392\u5e8f\u987a\u5e8f\u3002\n?animal_type_id=1\uff1a\u6307\u5b9a\u7b5b\u9009\u6761\u4ef6<\/code><\/pre>\n
\u53c2\u6570\u7684\u8bbe\u8ba1\u5141\u8bb8\u5b58\u5728\u5197\u4f59\uff0c\u5373\u5141\u8bb8API\u8def\u5f84\u548cURL\u53c2\u6570\u5076\u5c14\u6709\u91cd\u590d\u3002\u6bd4\u5982\uff0cGET \/zoo\/ID\/animals \u4e0e GET \/animals?zoo_id=ID \u7684\u542b\u4e49\u662f\u76f8\u540c\u7684\u3002<\/p>\n
5. \u4e0d\u7b26\u5408 CRUD \u60c5\u51b5\u7684 RESTful API<\/h3>\n
\u5728\u5b9e\u9645\u8d44\u6e90\u64cd\u4f5c\u4e2d\uff0c\u603b\u4f1a\u6709\u4e00\u4e9b\u4e0d\u7b26\u5408 CRUD\uff08Create-Read-Update-Delete\uff09 \u7684\u60c5\u51b5\uff0c\u4e00\u822c\u6709\u51e0\u79cd\u5904\u7406\u65b9\u6cd5\u3002<\/p>\n
1\u3001\u4f7f\u7528 POST\uff0c\u4e3a\u9700\u8981\u7684\u52a8\u4f5c\u589e\u52a0\u4e00\u4e2a endpoint\uff0c\u4f7f\u7528 POST \u6765\u6267\u884c\u52a8\u4f5c\uff0c\u6bd4\u5982: POST \/resend \u91cd\u65b0\u53d1\u9001\u90ae\u4ef6\u3002<\/p>\n
2\u3001\u589e\u52a0\u63a7\u5236\u53c2\u6570\uff0c\u6dfb\u52a0\u52a8\u4f5c\u76f8\u5173\u7684\u53c2\u6570\uff0c\u901a\u8fc7\u4fee\u6539\u53c2\u6570\u6765\u63a7\u5236\u52a8\u4f5c\u3002\u6bd4\u5982\u4e00\u4e2a\u535a\u5ba2\u7f51\u7ad9\uff0c\u4f1a\u6709\u628a\u5199\u597d\u7684\u6587\u7ae0\u201c\u53d1\u5e03\u201d\u7684\u529f\u80fd\uff0c\u53ef\u4ee5\u7528\u4e0a\u9762\u7684 POST \/articles\/{:id}\/publish \u65b9\u6cd5\uff0c\u4e5f\u53ef\u4ee5\u5728\u6587\u7ae0\u4e2d\u589e\u52a0 published:boolean \u5b57\u6bb5\uff0c\u53d1\u5e03\u7684\u65f6\u5019\u5c31\u662f\u66f4\u65b0\u8be5\u5b57\u6bb5 PUT \/articles\/{:id}?published=true<\/p>\n
3\u3001\u628a\u52a8\u4f5c\u8f6c\u6362\u6210\u8d44\u6e90\uff0c\u628a\u52a8\u4f5c\u8f6c\u6362\u6210\u53ef\u4ee5\u6267\u884c CRUD \u64cd\u4f5c\u7684\u8d44\u6e90\uff0c github \u5c31\u662f\u7528\u4e86\u8fd9\u79cd\u65b9\u6cd5\u3002<\/p>\n
\u6bd4\u5982\u201c\u559c\u6b22\u201d\u4e00\u4e2a gist\uff0c\u5c31\u589e\u52a0\u4e00\u4e2a \/gists\/:id\/star \u5b50\u8d44\u6e90\uff0c\u7136\u540e\u5bf9\u5176\u8fdb\u884c\u64cd\u4f5c\uff1a\u201c\u559c\u6b22\u201d\u4f7f\u7528PUT \/gists\/:id\/star\uff0c\u201c\u53d6\u6d88\u559c\u6b22\u201d\u4f7f\u7528 DELETE \/gists\/:id\/star\u3002<\/p>\n
\u53e6\u5916\u4e00\u4e2a\u4f8b\u5b50\u662f Fork\uff0c\u8fd9\u4e5f\u662f\u4e00\u4e2a\u52a8\u4f5c\uff0c\u4f46\u662f\u5728 gist \u4e0b\u9762\u589e\u52a0 forks\u8d44\u6e90\uff0c\u5c31\u80fd\u628a\u52a8\u4f5c\u53d8\u6210 CRUD \u517c\u5bb9\u7684\uff1aPOST \/gists\/:id\/forks \u53ef\u4ee5\u6267\u884c\u7528\u6237 fork \u7684\u52a8\u4f5c\u3002<\/p>\n
6. \u52a8\u8bcd\u8986\u76d6\uff0c\u5e94\u5bf9\u670d\u52a1\u5668\u4e0d\u5b8c\u5168\u652f\u6301 HTTP \u7684\u60c5\u51b5<\/h3>\n
\u6709\u4e9b\u5ba2\u6237\u7aef\u53ea\u80fd\u4f7f\u7528GET\u548cPOST\u8fd9\u4e24\u79cd\u65b9\u6cd5\u3002\u670d\u52a1\u5668\u5fc5\u987b\u63a5\u53d7POST\u6a21\u62df\u5176\u4ed6\u4e09\u4e2a\u65b9\u6cd5\uff08PUT\u3001PATCH\u3001DELETE\uff09\u3002<\/p>\n
\u8fd9\u65f6\uff0c\u5ba2\u6237\u7aef\u53d1\u51fa\u7684 HTTP \u8bf7\u6c42\uff0c\u8981\u52a0\u4e0aX-HTTP-Method-Override\u5c5e\u6027\uff0c\u544a\u8bc9\u670d\u52a1\u5668\u5e94\u8be5\u4f7f\u7528\u54ea\u4e00\u4e2a\u52a8\u8bcd\uff0c\u8986\u76d6POST\u65b9\u6cd5\u3002<\/p>\n
API\u54cd\u5e94<\/h1>\n
1. \u6982\u8ff0<\/h3>\n
\u5ba2\u6237\u7aef\u7684\u6bcf\u4e00\u6b21\u8bf7\u6c42\uff0c\u670d\u52a1\u5668\u90fd\u5fc5\u987b\u7ed9\u51fa\u56de\u5e94\u3002\u56de\u5e94\u5305\u62ec HTTP \u72b6\u6001\u7801\u548c\u6570\u636e\u4e24\u90e8\u5206\u3002<\/p>\n
HTTP \u72b6\u6001\u7801\u5c31\u662f\u4e00\u4e2a\u4e09\u4f4d\u6570\uff0c\u5206\u6210\u4e94\u4e2a\u7c7b\u522b\u3002<\/p>\n
1xx\uff1a\u76f8\u5173\u4fe1\u606f\n2xx\uff1a\u64cd\u4f5c\u6210\u529f\n3xx\uff1a\u91cd\u5b9a\u5411\n4xx\uff1a\u5ba2\u6237\u7aef\u9519\u8bef\n5xx\uff1a\u670d\u52a1\u5668\u9519\u8bef<\/code><\/pre>\n
\u8fd9\u4e94\u5927\u7c7b\u603b\u5171\u5305\u542b100\u591a\u79cd\u72b6\u6001\u7801\uff0c\u8986\u76d6\u4e86\u7edd\u5927\u90e8\u5206\u53ef\u80fd\u9047\u5230\u7684\u60c5\u51b5\u3002\u6bcf\u4e00\u79cd\u72b6\u6001\u7801\u90fd\u6709\u6807\u51c6\u7684\uff08\u6216\u8005\u7ea6\u5b9a\u7684\uff09\u89e3\u91ca\uff0c\u5ba2\u6237\u7aef\u53ea\u9700\u67e5\u770b\u72b6\u6001\u7801\uff0c\u5c31\u53ef\u4ee5\u5224\u65ad\u51fa\u53d1\u751f\u4e86\u4ec0\u4e48\u60c5\u51b5\uff0c\u6240\u4ee5\u670d\u52a1\u5668\u5e94\u8be5\u8fd4\u56de\u5c3d\u53ef\u80fd\u7cbe\u786e\u7684\u72b6\u6001\u7801\u3002<\/p>\n
2. \u72b6\u6001\u7801<\/h3>\n
1xx \u72b6\u6001\u7801<\/strong><\/p>\n
API \u4e0d\u9700\u89811xx\u72b6\u6001\u7801\uff0c\u4e0b\u9762\u4ecb\u7ecd\u5176\u4ed6\u56db\u7c7b\u72b6\u6001\u7801\u7684\u7cbe\u786e\u542b\u4e49\u3002<\/p>\n
2xx \u72b6\u6001\u7801<\/strong><\/p>\n
200\u72b6\u6001\u7801\u8868\u793a\u64cd\u4f5c\u6210\u529f\uff0c\u4f46\u662f\u4e0d\u540c\u7684\u65b9\u6cd5\u53ef\u4ee5\u8fd4\u56de\u66f4\u7cbe\u786e\u7684\u72b6\u6001\u7801\u3002<\/p>\n
GET:    200 OK\nPOST:   201 Created\nPUT:    200 OK\nPATCH:  200 OK\nDELETE: 204 No Content<\/code><\/pre>\n
\u4e0a\u9762\u4ee3\u7801\u4e2d\uff0cPOST\u8fd4\u56de201\u72b6\u6001\u7801\uff0c\u8868\u793a\u751f\u6210\u4e86\u65b0\u7684\u8d44\u6e90\uff1bDELETE\u8fd4\u56de204\u72b6\u6001\u7801\uff0c\u8868\u793a\u8d44\u6e90\u5df2\u7ecf\u4e0d\u5b58\u5728\u3002<\/p>\n
3xx \u72b6\u6001\u7801<\/strong><\/p>\n
API \u7528\u4e0d\u5230301\u72b6\u6001\u7801\uff08\u6c38\u4e45\u91cd\u5b9a\u5411\uff09\u548c302\u72b6\u6001\u7801\uff08\u6682\u65f6\u91cd\u5b9a\u5411\uff0c307\u4e5f\u662f\u8fd9\u4e2a\u542b\u4e49\uff09\uff0c\u56e0\u4e3a\u5b83\u4eec\u53ef\u4ee5\u7531\u5e94\u7528\u7ea7\u522b\u8fd4\u56de\uff0c\u6d4f\u89c8\u5668\u4f1a\u76f4\u63a5\u8df3\u8f6c\uff0cAPI \u7ea7\u522b\u53ef\u4ee5\u4e0d\u8003\u8651\u8fd9\u4e24\u79cd\u60c5\u51b5\u3002<\/p>\n
API \u4e3b\u8981\u662f\u7528303 See Other\uff0c\u8868\u793a\u53c2\u8003\u53e6\u4e00\u4e2a URL\u3002\u5b83\u4e0e302\u548c307\u7684\u542b\u4e49\u4e00\u6837\uff0c\u4e5f\u662f\u201d\u6682\u65f6\u91cd\u5b9a\u5411\u201d\uff0c\u533a\u522b\u5728\u4e8e302\u548c307\u7528\u4e8eGET\u8bf7\u6c42\uff0c\u800c303\u7528\u4e8ePOST\u3001PUT\u548cDELETE\u8bf7\u6c42\u3002\u6536\u5230303\u4ee5\u540e\uff0c\u6d4f\u89c8\u5668\u4e0d\u4f1a\u81ea\u52a8\u8df3\u8f6c\uff0c\u800c\u4f1a\u8ba9\u7528\u6237\u81ea\u5df1\u51b3\u5b9a\u4e0b\u4e00\u6b65\u600e\u4e48\u529e\u3002\u4e0b\u9762\u662f\u4e00\u4e2a\u4f8b\u5b50\u3002<\/p>\n
HTTP\/1.1 303 See Other\nLocation: \/api\/orders\/12345<\/code><\/pre>\n
4xx \u72b6\u6001\u7801<\/strong><\/p>\n
4xx \u72b6\u6001\u7801\u8868\u793a\u5ba2\u6237\u7aef\u9519\u8bef\uff0c\u4e3b\u8981\u6709\u4e0b\u9762\u51e0\u79cd\uff1a<\/p>\n
400 Bad Request\uff1a\u670d\u52a1\u5668\u4e0d\u7406\u89e3\u5ba2\u6237\u7aef\u7684\u8bf7\u6c42\uff0c\u672a\u505a\u4efb\u4f55\u5904\u7406\u3002\n401 Unauthorized\uff1a\u7528\u6237\u672a\u63d0\u4f9b\u8eab\u4efd\u9a8c\u8bc1\u51ed\u636e\uff0c\u6216\u8005\u6ca1\u6709\u901a\u8fc7\u8eab\u4efd\u9a8c\u8bc1\u3002\n403 Forbidden\uff1a\u7528\u6237\u901a\u8fc7\u4e86\u8eab\u4efd\u9a8c\u8bc1\uff0c\u4f46\u662f\u4e0d\u5177\u6709\u8bbf\u95ee\u8d44\u6e90\u6240\u9700\u7684\u6743\u9650\u3002\n404 Not Found\uff1a\u6240\u8bf7\u6c42\u7684\u8d44\u6e90\u4e0d\u5b58\u5728\uff0c\u6216\u4e0d\u53ef\u7528\u3002\n405 Method Not Allowed\uff1a\u7528\u6237\u5df2\u7ecf\u901a\u8fc7\u8eab\u4efd\u9a8c\u8bc1\uff0c\u4f46\u662f\u6240\u7528\u7684 HTTP \u65b9\u6cd5\u4e0d\u5728\u4ed6\u7684\u6743\u9650\u4e4b\u5185\u3002\n410 Gone\uff1a\u6240\u8bf7\u6c42\u7684\u8d44\u6e90\u5df2\u4ece\u8fd9\u4e2a\u5730\u5740\u8f6c\u79fb\uff0c\u4e0d\u518d\u53ef\u7528\u3002\n415 Unsupported Media Type\uff1a\u5ba2\u6237\u7aef\u8981\u6c42\u7684\u8fd4\u56de\u683c\u5f0f\u4e0d\u652f\u6301\u3002\u6bd4\u5982\uff0cAPI \u53ea\u80fd\u8fd4\u56de JSON \u683c\u5f0f\uff0c\u4f46\u662f\u5ba2\u6237\u7aef\u8981\u6c42\u8fd4\u56de XML \u683c\u5f0f\u3002\n422 Unprocessable Entity \uff1a\u5ba2\u6237\u7aef\u4e0a\u4f20\u7684\u9644\u4ef6\u65e0\u6cd5\u5904\u7406\uff0c\u5bfc\u81f4\u8bf7\u6c42\u5931\u8d25\u3002\n429 Too Many Requests\uff1a\u5ba2\u6237\u7aef\u7684\u8bf7\u6c42\u6b21\u6570\u8d85\u8fc7\u9650\u989d\u3002<\/code><\/pre>\n
5xx \u72b6\u6001\u7801<\/strong><\/p>\n
5xx\u72b6\u6001\u7801\u8868\u793a\u670d\u52a1\u7aef\u9519\u8bef\u3002\u4e00\u822c\u6765\u8bf4\uff0cAPI \u4e0d\u4f1a\u5411\u7528\u6237\u900f\u9732\u670d\u52a1\u5668\u7684\u8be6\u7ec6\u4fe1\u606f\uff0c\u6240\u4ee5\u53ea\u8981\u4e24\u4e2a\u72b6\u6001\u7801\u5c31\u591f\u4e86\u3002<\/p>\n
500 Internal Server Error\uff1a\u5ba2\u6237\u7aef\u8bf7\u6c42\u6709\u6548\uff0c\u670d\u52a1\u5668\u5904\u7406\u65f6\u53d1\u751f\u4e86\u610f\u5916\u3002\n503 Service Unavailable\uff1a\u670d\u52a1\u5668\u65e0\u6cd5\u5904\u7406\u8bf7\u6c42\uff0c\u4e00\u822c\u7528\u4e8e\u7f51\u7ad9\u7ef4\u62a4\u72b6\u6001\u3002<\/code><\/pre>\n
3. \u8fd4\u56de\u6570\u636e<\/h3>\n
3.1 \u4e0d\u8981\u8fd4\u56de\u7eaf\u672c\u6587<\/strong><\/p>\n
API \u8fd4\u56de\u7684\u6570\u636e\u683c\u5f0f\uff0c\u4e0d\u5e94\u8be5\u662f\u7eaf\u6587\u672c\uff0c\u800c\u5e94\u8be5\u662f\u4e00\u4e2a JSON \u5bf9\u8c61\uff0c\u56e0\u4e3a\u8fd9\u6837\u624d\u80fd\u8fd4\u56de\u6807\u51c6\u7684\u7ed3\u6784\u5316\u6570\u636e\u3002\u6240\u4ee5\uff0c\u670d\u52a1\u5668\u56de\u5e94\u7684 HTTP \u5934\u7684Content-Type\u5c5e\u6027\u8981\u8bbe\u4e3aapplication\/json\u3002<\/p>\n
\u5ba2\u6237\u7aef\u8bf7\u6c42\u65f6\uff0c\u4e5f\u8981\u660e\u786e\u544a\u8bc9\u670d\u52a1\u5668\uff0c\u53ef\u4ee5\u63a5\u53d7 JSON \u683c\u5f0f\uff0c\u5373\u8bf7\u6c42\u7684 HTTP \u5934\u7684ACCEPT\u5c5e\u6027\u4e5f\u8981\u8bbe\u6210application\/json\u3002<\/p>\n
3.2 \u4e0d\u8981\u5305\u88c5\u6570\u636e<\/strong><\/p>\n
response \u7684 body\u76f4\u63a5\u5c31\u662f\u6570\u636e\uff0c\u4e0d\u8981\u505a\u591a\u4f59\u7684\u5305\u88c5\u3002\u9519\u8bef\u5b9e\u4f8b\uff1a<\/p>\n
{"success":true, "data":{"id":1, "name":"\u5468\u4f2f\u901a"} }<\/code><\/pre>\n
\u9488\u5bf9\u4e0d\u540c\u64cd\u4f5c\uff0c\u670d\u52a1\u5668\u5411\u7528\u6237\u8fd4\u56de\u7684\u7ed3\u679c\u5e94\u8be5\u7b26\u5408\u4ee5\u4e0b\u89c4\u8303\u3002<\/p>\n
GET    \/collection\uff1a\u8fd4\u56de\u8d44\u6e90\u5bf9\u8c61\u7684\u5217\u8868\uff08\u6570\u7ec4\uff09\nGET    \/collection\/resource\uff1a\u8fd4\u56de\u5355\u4e2a\u8d44\u6e90\u5bf9\u8c61\nPOST   \/collection\uff1a\u8fd4\u56de\u65b0\u751f\u6210\u7684\u8d44\u6e90\u5bf9\u8c61\nPUT    \/collection\/resource\uff1a\u8fd4\u56de\u5b8c\u6574\u7684\u8d44\u6e90\u5bf9\u8c61\nPATCH  \/collection\/resource\uff1a\u8fd4\u56de\u5b8c\u6574\u7684\u8d44\u6e90\u5bf9\u8c61\nDELETE \/collection\/resource\uff1a\u8fd4\u56de\u4e00\u4e2a\u7a7a\u6587\u6863<\/code><\/pre>\n
3.3 \u53d1\u751f\u9519\u8bef\u65f6\uff0c\u4e0d\u8981\u8fd4\u56de 200 \u72b6\u6001\u7801<\/strong><\/p>\n
\u6709\u4e00\u79cd\u4e0d\u6070\u5f53\u7684\u505a\u6cd5\u662f\uff0c\u5373\u4f7f\u53d1\u751f\u9519\u8bef\uff0c\u4e5f\u8fd4\u56de200\u72b6\u6001\u7801\uff0c\u628a\u9519\u8bef\u4fe1\u606f\u653e\u5728\u6570\u636e\u4f53\u91cc\u9762\uff0c\u5c31\u50cf\u4e0b\u9762\u8fd9\u6837\u3002<\/p>\n
{"status": "failure", "data": { "error": "Expected at least two items in list."} }<\/code><\/pre>\n
\u6b63\u786e\u7684\u505a\u6cd5\u662f\uff0c\u72b6\u6001\u7801\u53cd\u6620\u53d1\u751f\u7684\u9519\u8bef\uff0c\u5177\u4f53\u7684\u9519\u8bef\u4fe1\u606f\u653e\u5728\u6570\u636e\u4f53\u91cc\u9762\u8fd4\u56de\u3002\u4e0b\u9762\u662f\u4e00\u4e2a\u4f8b\u5b50\u3002<\/p>\n
HTTP\/1.1 400 Bad Request\nContent-Type: application\/json\n{\n  "error": "Invalid payoad.",\n  "detail": {\n    "surname": "This field is required."\n  }\n}<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
RESTful\u6982\u8ff0 \u4e3a\u4ec0\u4e48\u8981\u4f7f\u7528RESTful\u67b6\u6784 REST \u662f Representational State Transfer \u7684\u7f29\u5199   \u2026 …<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"ngg_post_thumbnail":0},"categories":[190],"tags":[],"_links":{"self":[{"href":"\/index.php?rest_route=\/wp\/v2\/posts\/8924"}],"collection":[{"href":"\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=8924"}],"version-history":[{"count":2,"href":"\/index.php?rest_route=\/wp\/v2\/posts\/8924\/revisions"}],"predecessor-version":[{"id":8926,"href":"\/index.php?rest_route=\/wp\/v2\/posts\/8924\/revisions\/8926"}],"wp:attachment":[{"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=8924"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=8924"},{"taxonomy":"post_tag","embeddable":true,"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=8924"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}