建立資源

並非所有人都同意資源建立的語義最正確的方法是什麼。因此,你的 API 可以接受 POSTPUT 請求,或者其中之一。

如果資源已成功建立,伺服器應使用 201 Created 進行響應。如果不是,請選擇最合適的錯誤程式碼。

例如,如果你提供 API 來建立員工記錄,請求/響應可能如下所示:

POST /employees HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "Charlie Smith",
    "age": 38,
    "job_title": "Software Developer",
    "salary": 54895.00
}
HTTP/1.1 201 Created
Location: /employees/1/charlie-smith
Content-Type: application/json

{
    "employee": {
        "name": "Charlie Smith",
        "age": 38,
        "job_title": "Software Developer",
        "salary": 54895.00
        "links": [
            {
                "uri": "/employees/1/charlie-smith",
                "rel": "self",
                "method": "GET"
            },
            {
                "uri": "/employees/1/charlie-smith",
                "rel": "delete",
                "method": "DELETE"
            },
            {
                "uri": "/employees/1/charlie-smith",
                "rel": "edit",
                "method": "PATCH"
            }
        ]
    },
    "links": [
        {
            "uri": "/employees",
            "rel": "create",
            "method": "POST"
        }
    ]
}

在響應中包含 links JSON 欄位使客戶端能夠訪問與新資源和整個應用程式相關的資源,而無需事先知道它們的 URI 或方法。