跳到主要內容

RPC-Style API VS REST API

Problem

幾年前聽到同事說:「另一個部門的XXX說我們的REST API都沒有動詞，這樣是對的嗎?」於是我們就直接把Best Practice丟給那位同事。當時做REST API只是因為別人有而要做，而不是為了某個Context而選擇REST；後來我就思考著一件事情: 「RPC-Style與REST API比起來，到底有哪些好處?」於是我花了些時間去找尋與整理資料。首先我會先說明這裡指的RPC-style API是什麼，接著我會透過Richardson Maturity Model(RMM)說明它們兩者的差異。這是我目前認為最好的比較方式。

RPC-style API

網路上許多比較，大都是針對RPC與REST；我所說的RPC-style API是基於HTTP，主要有兩點特徵:

  1. 基於operation所設計出來的API，因此URI通常像/createAccount、/getAccounts、/deleteAccount與/updateAccount。
  2. HTTP method只會使用GET與POST，GET使用在取得資料，POST使用在新增、修改、刪除資料。

基於RMM的比較

RMM不是定義REST達到了什麼級別，而是幫助我們層層思考的一種方式(參考)。Roy Fielding 2008年的某篇文章，給了RESTful API很嚴格的限制，也代表著Level 3只是Restful的前置條件。由於RPC-style API屬於Level 0，因此我認為用RMM來說明REST API比RPC-style好在哪裡是再適合不過的:

(圖片來自於link)
我們可以從Level 1~Level3來分別討論:

Level 1 - Resource

REST API的操作是基於Resource的。這代表著Server的設計是基於Resource，而Client的操作也是基於Resource。這為Server與Client帶來一些好處:

Server

物件導向程式設計的特性之一: Divide and Conquer，將一個複雜的問題分解成各個資源；把相關的操作放於同一資源當中，以達到high cohesion。

Client

第一個好處是由於Server的設計以資源為導向，這讓User很容易了解系統的Domain Concept；其次是由於這幾年REST風格的盛行，讓開發人員更容易熟悉API的使用(參考link)；最後是API document容易閱讀，這點從Slack的RPC-style API document使用resource的方式去分類就可以得知。

Level 2 - HTTP Verb

透過將資源的新增查詢修改刪除對應到POST、GET、PUT、DELETE，這讓大家有一致的作法，避免不必要的變化。也讓我們得知某一資源的URI後，就可以直接透過HTTP Verb去操作它，利於我們去閱讀Document。這有別於使用RPC-style時，因大家各自命名的方式而變成一定要閱讀document。

Level 3 - Hypermedia Controls

Hypermedia使得Resource有了self-document的能力，包含描述Resource接下來可以做的事情，這讓API擁有了discoverability的特性。你可能會問，RPC-style API幹嘛需要什麼discoverability的特性呢?其實因為self-document的關係，讓我在使用REST API時，並不一定需要去查user guide；可以直接透過link點擊到與Resource相關的sub-resource，這是一個非常好用的功能! 除此之外，Hypermedia還增加了Server Scalability(參考、參考)與API evolution(參考)。

首先是Server Scalability。由於stateless與透過link rel互動的緣故，client與server是decoupling的；這也使得client除了root uri以外，根本不需要去管其它Resource對應到的server位置:

"links": [
    {
        "rel": "search",
        "method": "POST",
        "href": "https://192.168.0.1/api/search"
    },
    {
        "rel": "get_accounts",
        "method": "GET",
        "href": "https://192.168.0.2/api/accounts"
    }
 ]

也因此resource名稱對於client來說，在runtime時就不是這麼重要了，重要的是rel的名稱；這應該是Roy Fielding在這篇文章說以下內容的原因吧:

A REST API must not define fixed resource names or hierarchies (an obvious coupling of client and server).

而API evolution也因為透過link ref與Resource互動的特性，使得你不用害怕改Resource的名稱。

Summary

我只針對REST比RPC-style好在哪裡做說明，這不代表著REST就一定比RPC-style好。下圖是我以前念書時候的一個作業，雖然server使用物件導向去設計model，但與client的溝通我還是選擇了RPC-style的方式:

假如是一個不是很大的專案，而且client只有我自己，我還是很有可能選擇使用這樣的方式，因為簡單且省時。重點是要使用甚麼方式，是要看當時所面對的Context，這也讓我思考hypermedia的特性到底對我們有沒有用。

這裡補充別人針對hypermedia API統計的資料給大家參考:

  • 2014年CA Technologies從180個API供應商中，得知有26.3%有實作hypermedia API，有28%要支援此功能。(link)
  • 2015年Akana舉辦一個線上研討會，從76人中得知有16%的人正在使用hypermedia API，而40%的人計畫要使用。(link)

以上是目前的心得分享。

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後，Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護，我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情，主要先把明確的runtime語法錯誤與deprecate item處理好，這部分內容可以參考: link 。 直到最近才發現，透過SeleniumLibrary執行Choose File去上傳檔案的動作，會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法，我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住，有些測試案例是可以執行的，但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作，因為我使用 Remote Selenium ，所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現，在3.2.2的最後一個TCP封包，比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容，還有HTTP Content-Length的計算，我都確認過沒有問題。 最後發現問題是出在socket API的使用上，就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料，但沒處理到尚未送完的資料內容，而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方，在他們出新的版本之前，我是將改完的_socket.py放在我們自己的Lib底下，好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)
張貼留言
閱讀完整內容

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後，安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數，以前試驗過是可以安裝完成的。因此在發生這個問題後，我檢查了它的debug console: 從console得知，eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認，有問題的是有接網路線的網卡，且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制，因此發現在Anaconda的說明文件中( link )，有提到dhcptimeout這個boot參數。看了一些人的使用範例，應該是可以直接串在isolinux.cfg中，如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串，問問Google大師，想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ，關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中；在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知，它讀取的檔案是answer file而不是boot command line。因此我接下來的測試，就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...
張貼留言
閱讀完整內容

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol，我對它的認識也是從工作接觸開始。雖說是管理網路設備，但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式，當然所有的操作也都可以透過SNMP來完成，不過可能會很痛苦。前陣子遇到一個學弟，它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。 在這篇文章中，不是要告訴你SNMP是什麼，會看這篇文章的大哥們，應該已經對SNMP有些認識了。 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid，有MIB可以幫助你去了解它所提供的資訊是什麼，且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作，也讓我順便了解一下它的語法，接下來我要交給大家MIB的基礎認識。 smidump 我並非使用什麼高強的Editor去編寫MIB，我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具，唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! 安裝 在Ubuntu上可先輸入smidump確認是否安裝，如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi) root@tonylin:~/multi-boot-server# smidump The program 'smidump' is currently not installed. You can install it by typing: apt-get install libsmi2ldbl 使用 透過下面兩行指令，就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 smidump -f tree example1.mib > xtree.txt smidump -f identifiers example1.mib > xiden.txt 如果有參考其它檔案要加上p的參數: smidum...
張貼留言
閱讀完整內容