基於HTTP標準協議的API介面設計規範構思

2021-09-17 07:05:39 字數 1018 閱讀 8559

版本控制git

開發流程git flow

請求方式

url動作

中文說明

get/resources/list

列表post

/resources/create

建立get

/resources/:idretrieve

詳細put

/resources/:idupdate

更新patch

/resources/:idpartial_update

部分更新

delete

/resources/:iddestroy

刪除請求支援form-date,json,x-www-form-urlencode

返回格式統一為json

乙個請求對應乙個serializer

錯誤資訊包含在返回內容裡

不同的錯誤對應不同的錯誤資訊**

http錯誤碼按照標準用法使用

jwttoken

oauth2

以中介軟體形式作為許可權鑑別外掛程式,根據http請求格式直接判斷許可權

使用者登入成功時,將使用者資訊與許可權資訊快取保證效率

日誌以中介軟體形式提供

根據業務需求氛圍入庫日誌與普通日誌

根據上面的介面格式寫文件

,

"response": {}

},"create": ,

"response": {}

},"retrieve":

},"update": ,

"response": {}

},"partial_update": ,

"response": {}

},"destroy": {}

}}

業務所需介面測試覆蓋率100%

待完善

標準Http協議的請求方法

標準http協議的請求方法 標準http協議支援六種請求方法,即 0,get 1,head 2,put 3,delete 4,post 5,options 但其實我們大部分情況下只用到了get和post。如果想設計乙個符合restful規範的web應用程式,則這六種方法都會用到。不過即使暫時不想涉及...

基於HTTP功能追加的協議

隨著web用途的多樣性,http協議上的限制以及自身效能問題逐漸顯露出來,http功能上的不足可以通過建立一套全新的協議來彌補。可是目前基於http的web瀏覽器使用環境遍布全球,因此無法拋棄http。一些新的協議在http的基礎上新增了新的功能。為了盡可能實時顯示這些更新的內容,伺服器上一有內容更...

基於http的API的安全性

基於http的api,怎麼保證安全性?當前的資訊系統,安全第一道關卡,當然就是密碼了。api也不例外。要麼就是一次性登入,獲得乙個短期內有效的token 要麼就是每次請求都帶上賬號和密碼。如果是每次都帶上賬號和密碼,那麼api站點必須要求使用https,否則有洩露風險。當然變通方法可以是採用非對稱加...