1. 程式人生 > >rest 在java中的最佳實踐

rest 在java中的最佳實踐

什麼是rest

一種軟體架構風格,在程式碼中形成一種規範,一種約定,一種約束,可以降低開發的複雜性,提高系統的安全性、可伸縮性

最賤實踐

    最佳實踐(test practice)是一個管理學概念,認為存在某種技術、方法、過程、活動、或者機制可以使生產或者管理實踐的結果達到最優,並減少出錯的可能性。

    所謂最佳實踐,是那些已經在別處產生顯著效果,並能使用於此處的優秀實踐。

    

應用

rest 風格的要求

返回的狀態碼,必須嚴格遵循規則,

@PostMapping
@ResponseBody
public ResponseEntity<Item> saveItem(Item item){
    if(item.getPrive()==null){
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(null);
    }
    item = itemService.saveItem(item);
    return ResponseEntity.status(HttpStatus.CREATED).body(item);
}

1,路徑的要求

get:獲取資源

post:建立資源

put:修改資源

delete:刪除資源

rest風格中路徑中不能有動詞

用一樣的url,通過請求型別判斷增刪改查,

 

介面設計

url的組成

  網路協議(http、https)

  伺服器地址

  介面名稱

  引數列表

url定義限定

不要使用大寫字母

使用中線“-”代替“_”

引數應該被encode過

響應設計

響應規則

Content body 僅僅用來傳輸資料

資料要做到拿來就可用的原則,不需要拆箱的過程

用來描述資料或者請求的元資料放Header中,例如X-Result-Fields