筆記 REST API 設計

2021-07-03 14:59:43 字數 1305 閱讀 5272

evernote export body, td

04/07/2015 saturday 15:50

04/07/2015 saturday 17:48

liker.xu

@head:安全+冪等

@options:安全+冪等

@put(寫操作):更新或新增資源:冪等,多次插入或者更新同乙份資料,不安全

@post:既不冪等也不安全

@delete:冪等

webdev拓展方法(不遵從roa(面向資源架構)的拓展介面)p77

資源路徑概覽:scheme://host:port/path?querystring1&querystring2

查詢引數》查詢條件》查詢作用域

排序並分頁查詢列表資料:/queryresource/sorted-books/limit=5%sort=pronouce

查詢單項資料:/query-resource/books?id=8

@path(「-」)

public string getbycondition(@pathparam(「引數名稱1」) final integer a,@pathparam(「引數名稱2」) final integer b)

@path與@pathparam配合使用

路徑區間pathsegment(使資源類的乙個方法支援更廣泛的資源位址的請求)

@formparam:定義表單引數

@path(「form-resource」)

public class fromresource(@defaultvalue(「liker」) @formresource.user final string user,@encoded @formparam(formresourcep.pw) final string password,@encoded @formparam(formresource.npw) final string newpassword,@enocded @formparam(formresource.vnpw) final string vertifictation)

@encode 禁用自動解碼;@@defaultvalue 為客戶端沒有提供的引數值提供預設值

@beanparam:自定義引數組合(用簡潔的引數設計完成介面設計)

}//定義了一系列rest方法會用到的引數型別

@cookieparam:用以匹配cookie中的鍵值對資訊

@context:解析上下文引數

@context final uriinfo uriinfo:路徑資訊上下文

REST API設計規範

這裡整理的rest api的設計規範,注意和後端開發的api介面文件做一下區分,不是乙個概念。api是rest api的超集,rest api 是api的子集 所有的rest api都是api,但不是所有的api都是rest api api通常使用https協議,確保互動資料的傳輸安全,網域名稱盡量...

REST API許可權整合設計

應用分為兩大部分,前端html 後端rest服務,前端html和後端rest服務部署完全分離。目標 可訪問資源都處於許可權控制之下 意味著通過瀏覽器位址列的任意url都會被攔截 並提供跨域訪問支援。upm提供對整個應用系統中關於資源和使用者角色關係的許可權配置,並且對外提供認證和授權的介面。業務流 ...

API設計指南 RestAPI設計最佳實踐

類似於阿里巴巴的開發規範或者谷歌的開發規範,api設計是目前很多場景下的基本功,所以這裡給出乙個筆者的最佳實踐。rest,即representational state transfer的縮寫,關於restful架構,可以參考 架構之美 中的定義。get 獲取資源 post 更新資源 put 更新資...