去年剛入職這家公司的時候要求用restful,微服務。
給整的一臉懵逼。最後發現restful一點也不神奇。
特此 記錄一下精華,給需要的小夥伴。
精華 1 ,http的請求方式 表示動作 !http的請求方式 表示動作 !!http的請求方式 表示動作 !!!
常用的四種 get,post,put,delete
得到數據就用get,新增數據就用post,修改就用put,刪除就用delete
2 地址中不要有動詞!地址中不要有動詞!!地址中不要有動詞!!!
http的請求方式已經表明想要做什麼,所以不需要在地址用加動詞。
示例錯誤的 api
get /api/v1.0/getUser
post /api/v1.0/saveUser
post /api/v1.0/updateUser
post /api/v1.0/deleteUser
正確的resutful風格的接口
get /api/v1.0/user
post /api/v1.0/user
put /api/v1.0/user
delete /api/v1.0/user
自認比較規範的後臺接口示意
上面的controller生成的swagger 如下
完畢,qq 102528071 小夥伴們可以交流一下。