REST API 筆記1

一、一些與REST API 相關的重要術語

  • 資源(Resource)是一個對象或對某物的表示。它有一些相關聯的數據,並有一組方法進行操作。 例如:動物,學校和員工是資源。 這些資源都有着刪除,添加,更新,查詢操作。
  • 集合(Collection)是一系列資源,例如:公司集合是很多公司的集合。
  • URL (統一資源定位符) 是一種路徑,可以通過它定位資源並且也可以對它執行一些動作。

二、API端點(路徑)

  1. 每個URL代表一種資源(Resourse), 所以URL中只能有名詞,不能有動詞。 API路徑/addNewEmployee 包含了操作addNew和資源名稱Employee.
  2. 資源 在API端點中應該總是複數,如果我們想訪問資源的一個實例,我們可以傳遞URL中的id.
  3. URL 是一個句子,其中資源的名詞,HTTP方法是動詞
    4.主要的HTTP方法如下
    • GET 方法從資源請求數據,不產生多餘結果。例如:/companies/3/employees 會返回公司3的所有僱員列表。
    • POST 方法請求服務器在數據庫中創建資源,這主要用於提交web表單時。例如:/companies/3/empolyees 創建一個公司3的新僱員 POST是非冪等的,這意味着多個請求將會有不同的效果。
    • PUT 方法請求服務器更新資源或創建資源(如果不存在) 例如:/companies/3/employees/john 將請求服務器在公司3的僱員集合中更新或在不存在的情況下創建關於john的資源。 PUT 是冪等的,這意味着多次請求具有相同的效果。
    • DELETE 方法將請求的資源或實例從數據庫中刪除
      例如:/companies/3/employees/john/ 將請求服務器從公司3的僱員集中刪除john資源。

三、HTTP 響應狀態碼

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章