HTTP API: 該如何管理一份很大的OpenAPI document?
OpenAPI的document文件可以變得非常大一份,特別是當你有好幾百個routes的時候,
這時候單一份的yaml檔管理起來可能會非常頭大,這篇文章將分享在這種情況下,
我是如何將一份大的檔案拆分成許多小的檔案,易於管理。
OpenAPI Specification
OpenAPI也被稱為Swagger,是一個用來描述你的API的標準,可以根據這個標準來撰寫你的文件,
我想你應該很熟悉了,如果還不熟的,
可以先看看官方的說明: OpenAPI specification。
我如何拆分檔案
使用JSON格式
官網上的範例文件都是使用yaml,而我偏好使用JSON,
Pagination 是什麼?API 分頁設計完整指南
Pagination(分頁)是什麼?為什麼 API 需要分頁?完整介紹 Offset、Cursor 兩種分頁做法的差異與實作方式,讓你的 REST API 回應更快、體驗更好。
如何開始開發你的API: API first principle and OpenAPI
開發API應該要使用怎樣的流程,先定義好介面有哪些好處,以及可以使用哪些工具呢?(OpenAPI 3.0)
RESTful API: How to design paths and identify resources
繼上篇文章RESTful API簡介: 什麼是RESTful? 以及為何需要它?後,
我們知道了RESTful API是resource based的,今天講著重討論該如何設計resource,也就是HTTP URL中path的部分。
Resource based
每個URL都應該對應到一個或多個資源,使用那些使用者與你的服務互動時會需要用到的資源(名詞),
並使用HTTP Method來表明你想要對資源的操作(動詞),比如說你是一個網誌服務,
RESTful API簡介: 什麼是RESTful? 以及為何需要它?
在web開發裡,API是幾乎無所不在,而其中最常見的應該就是基於HTTP協議的RESTful API,
這篇簡介跟討論到底什麼是RESTful,為何有它的出現?
這是RESTful API一系列文章中的一篇,想了解更多關於RESTful API及HTTP的,可以看這篇目錄:
Introduction
首先,什麼是RESTful,可以說它是一種慣例,一個關於HTTP API如何設計的style,
慣例就是並沒有任何的強制性,但當大家都遵守的慣例時,特立獨行的邊緣人可能就會被排擠,
URL簡介: URL是什麼,由哪些部分組成?
這篇文章將會介紹什麼是URL,為何會需要它,以及它是由哪些部分組成的。
什麼是URL
想像你在一座大城市裡,你搭上一部計程車,想要去你朋友家、你小孩的幼兒園、或是去某某旅館,
你必須告訴司機地址; 如果你想聯絡到某人的話,會使用電話號碼; 在政府眼裡每個人有身分證字號。
就像如此,每個東西都有它獨特的識別方法,而且是被大家所公認的,也就是你一說,大家就知道你在說什麼,
知道你所指的是哪個東西,而在網路上,
HTTP headers 簡介: 一些常用的headers
在HTTP協議中,headers對於每個request,response提供了一些額外的資訊,基本上他們就是只是一對key value pair,由冒號(:)隔開,
今天會看看HTTP協議的格式,header在其中的位置,以及介紹一些常用的header們。
HTTP messages
HTTP是一個text based的傳輸協議,general的HTTP request message如下:
<method&
Introduction to HTTP Response Status Codes: How to use them correctly?
這篇文章會介紹在HTTP協議中,Response status code的作用,有哪些codes以及該如何去使用他們?
這是RESTful API一系列文章中的一篇,想了解更多關於RESTful API及HTTP的,可以看這篇目錄:
RESTful API Design — A practical guide
Client Server Model
HTTP是一個Client-Server的架構,
How to stream data from Blob Storage at your HTTP server using Azure and express.js
這篇文章將會示範如何使用Node.js來下載Azure Blob Storage上的檔案,並且使用Stream的方式,
將檔案儲存到本地端,或是作為一個Server(此篇使用express.js),回傳給你的client,並且根據檔案名稱來設置正確的Content-Type.
Download file from Azure
取得file的Readable Stream
const { ShareServiceClient, StorageSharedKeyCredential
RESTful API Design — A practical guide
此系列文章是Restful API design的教學目錄,將從什麼是API、怎樣是好的API、HTTP協議、RESTful是什麼、以及其他許多當你在設計API時會遇到情況,例如\:Documentation、Pagination、Rate Limiting、Monitoring.