首頁(yè) 猿問(wèn) rest...

rest API在做修改操作時(shí)，如何返回修改后的結(jié)果

JavaScript

猛跑小豬 2019-05-12 11:34:13

設(shè)計(jì)rest接口，對(duì)于修改(update,add,delete)操作，網(wǎng)上有說(shuō)應(yīng)該將修改后的結(jié)果返回調(diào)用方，調(diào)用方就可以直接利用這個(gè)修改后的結(jié)果。那么這個(gè)返回結(jié)果是將修改后的整個(gè)實(shí)體(比如User)返回，還是返回一個(gè)主鍵id。問(wèn)題1:①如果返回一個(gè)主鍵id。由于update和delete的id本來(lái)就是從調(diào)用端傳過(guò)來(lái)，因此不需要返回。而add時(shí)id是后臺(tái)生成的，所以需要返回給調(diào)用者。這樣的話，即使封裝了統(tǒng)一返回對(duì)象，感覺(jué)API的返回json還是不太統(tǒng)一。②如果返回實(shí)體。豈不是一個(gè)修改操作的api就要操作數(shù)據(jù)庫(kù)兩次(一次修改，一次查詢)請(qǐng)問(wèn)各位大大都是如何設(shè)計(jì)restAPI的呢？有沒(méi)有代碼分享一下？謝謝了！

查看完整描述

2 回答

慕無(wú)忌1623718

TA貢獻(xiàn)1744條經(jīng)驗(yàn) 獲得超4個(gè)贊

你好，RestfulAPI是一種設(shè)計(jì)風(fēng)格，并不是強(qiáng)制的標(biāo)準(zhǔn)我們可以對(duì)比一下傳統(tǒng)與其的寫法傳統(tǒng)寫法：查詢/user/query?name=tomGET詳情/user/getInfo?id=1GET創(chuàng)建/user/create?name=tomGET修改/user/update?id=1&name=jerryPOST刪除/user/delete?id=1GETRESTful寫法查詢/user?name=tomGET詳情/user/1GET創(chuàng)建/userPOST修改/user/1PUT刪除/user/1DELETE關(guān)于RestfulAPI的幾點(diǎn)說(shuō)法1、用URL描述資源2、使用HTTP方法描述行為，使用HTTP狀態(tài)碼來(lái)表示不同的結(jié)果3、使用json交互數(shù)據(jù)4、RESTful只是一種風(fēng)格，并不是強(qiáng)制的標(biāo)準(zhǔn)官方也有一個(gè)模型：Level0：使用Http作為傳輸方式Level1：引入資源概念，每個(gè)資源都有對(duì)應(yīng)的URLLevel2：使用HTTP方法進(jìn)行不同的操作，使用HTTP狀態(tài)碼來(lái)表示不同的結(jié)果Level3：使用超媒體，在資源的表達(dá)中包含了鏈接信息類似SpringMVC中開發(fā)RestfulAPI，一個(gè)查詢請(qǐng)求：——編寫針對(duì)RestfulAPI的測(cè)試用例——使用注解聲明RestfulAPI——在RestfulAPI中傳遞參數(shù)常用注解——@RestController標(biāo)明此Controller提供RestAPI——@RequestMapping及其變體，映射http請(qǐng)求url到j(luò)ava方法——@RequestParam映射請(qǐng)求參數(shù)到j(luò)ava方法的參數(shù)——@PageableDefault指定分頁(yè)參數(shù)默認(rèn)值而對(duì)于具體返回什么，或者獲取什么，更多的時(shí)候要根據(jù)業(yè)務(wù)的重點(diǎn)來(lái)設(shè)計(jì)。

反對(duì) 回復(fù) 2019-05-12