API 文件就是你的伺服器,REST 的另一個選擇:gRPC

在前幾個星期的文章中我們提到了「比起 JSON 更方便、更快速、更簡短的 Protobuf 格式」,但這還沒完。Google 為此推出了一個新的程式呼叫協議 gRPC,簡單說就是能夠從你的 Protobuf 檔案生出一個伺服器出來,這個好處就是不需要像傳統 RESTful API 伺服器ㄧ樣撰寫一堆路由。 當我們撰寫傳統 RESTful API 伺服器時,我們會花費許多的時間在路徑命名上。除此之外,

API Blueprint 撰寫教學

API Blueprint 是一個 API 文件撰寫風範,而且也有相關的工具可以將寫好的文件轉換成網頁,其實 API Blueprint 的寫法十分地簡單,先讓我們從開頭開始。 中繼資料 FORMAT: 1A 所謂的中繼資料即是 鍵名:值,從上述範例中你可以看到我們將 FORMAT 賦予一個 1A 的值,FORMAT 關鍵字是用來表示這份 API

別用 RAML 撰寫你的 API 文件,千萬不要。

這篇文章專門講解我如何被 RAML 騙到入坑然後放棄的過程。最近在找 API 文件工具,然後就剛好看見了 RAML,RAML 是一個撰寫 API 文件的格式,風格是延續 YAML 的。 現在讓我們看看官方網站的示意圖,你會發現:「哇,這根本夭壽棒啊!」。 所以我才被騙進來了,不是嗎?如果你現在打算用 RAML,請留步。 撰寫風格一般

RESTful API 的常用 HTTP 狀態碼

很常用到這些狀態碼,但是好像沒有人寫簡單點的說明,所以就自己寫了一個,以後應該會常常回來看。 成功 - 2xx 任何成功的狀態碼都是 2xx 開頭。 200 - 成功 請求已經成功,並且有返回內容。 201 - 已建立 請求成功,而且在伺服器上新建了一個資源(例如新增文章、留言)。 202 - 已接受