word版可編輯-restfulapi設(shè)計規(guī)范精心整理-文庫吧資料
2025-04-13 06:53本頁面
【正文】 67callback_function({如果API使用者確實無法訪問返回頭，或者API需要支持交叉域請求（通過jsonp）。}}理由很簡單：這樣做可以很容易擴(kuò)展返回結(jié)果，你可以加入一些分頁信息，一些數(shù)據(jù)的元信息等－這對于那些不容易訪問到返回頭的API使用者來說確實有用，但是隨著“標(biāo)準(zhǔn)”的發(fā)展（cors和），我個人推薦不要那么做。name : Johnid : 123,data : {只在需要的時候使用“envelope”很多API象下面這樣返回結(jié)果：123456{ 509 bytes在上面的例子中，%（沒有使用gzip），%。 1369 bytes $ gzip c $ gzip c 輸出如下：想象一個用戶正在debug那么默認(rèn)的輸出就是可讀的而不用將結(jié)果拷貝到其他什么軟件中在格式化是想起來就很爽的事，不是么？下面是一個例子:$ curl $ ruby r json e 39。格外的傳輸上的損失不會太大。默認(rèn)使用pretty print格式，使用gzip只是使用空格的返回結(jié)果從瀏覽器上看總是覺得很惡心(一大坨有沒有？～)。個人意見：我總覺得蛇形命令更好使一些，當(dāng)然這沒有什么理論的依據(jù)。命名方式？是蛇形命令（下劃線和小寫）還是駝峰命名？如果使用json那么最好的應(yīng)該是遵守JAVASCRIPT的命名方法也就是說駱駝命名法。如果是這樣的話你還有另外一個問題：你的請求中的media類型是應(yīng)該和accept 頭同步還是和url？為了方便（browser explorability）,應(yīng)該是在url中(用戶只要自己拼url就好了)。很多應(yīng)用（youtube,twitter,box）都已經(jīng)開始拋棄XML了，我也不想多費口舌。XML即冗長，難以閱讀，又不適合各種編程語言解析。（譯注：作者這里認(rèn)為HATEOAS還不算成熟，我也不怎么理解這段就算了，讀者感興趣可以自己去原文查看）是否需要 “HATEOAS“網(wǎng)上關(guān)于是否允許用戶創(chuàng)建新的url有很大的異議（注意不是創(chuàng)建資源產(chǎn)生的url）。更新和創(chuàng)建操作應(yīng)該返回資源PUT、POST、PATCH 操作在對資源進(jìn)行操作的時候常常有一些副作用：例如created_at,updated_at 時間戳。state=openamp。并且這個功能能有效的提高網(wǎng)絡(luò)帶寬使用率和速度。例如：get /ticketsq=recently_closed get /tickets/recently_closed.state=openamp。搜索：有些時候簡單的排序是不夠的。 GET /ticketssort=priority Retrieves a list of tickets in descending order of priority排序：和過濾一樣，一個好的排序參數(shù)應(yīng)該能夠描述排序規(guī)則，而不業(yè)務(wù)相關(guān)。過濾：為所有提供過濾功能的接口提供統(tǒng)一的參數(shù)。變化有時是不可避免的，關(guān)鍵是如何管理變化。strip使用的方法就很好：它的url里面有主版本信息，同時請求頭倆面有子版本信息。關(guān)于是否將版本信息放入url還是放入請求頭有過爭論：API version should be included in the URL or in a header. 學(xué)術(shù)界說它應(yīng)該放到header里面去，但是如果放到url里面我們就可以跨版本的訪問資源了。文檔中應(yīng)該有關(guān)于何時棄用某個API的時間表以及詳情。文檔應(yīng)該有展示請求和輸出的例子：或者以點擊鏈接的方式或者通過curl的方式（請見openstack的文檔）。文檔文檔和API本身一樣重要。值得注意的是：不要讓非SSL的url訪問重定向到SSL的url。有些是安全的，有些不是。4.永遠(yuǎn)使用SSL毫無例外，永遠(yuǎn)都要使用SSL。我認(rèn)為API的使用者對于/search這種url也不會有太大意見的（畢竟他很容易理解）。例如:github上，對一個gists加星操作：PUT /gists/:id/star 并且取消星操作：DELETE /gists/:id/star.3. 有時候action實在沒有難以和某個資源對應(yīng)上例如search。（例如
公司管理相關(guān)推薦
鄂ICP備17016276號-1