跳到主要內容

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

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php