API Survey #2 - Firebase Realtime Database

API Survey #2

Firebase Realtime Database

The Goal of API Survey

1. Analyze the design of public API ( compare to the principle of RESTful API)
   1. Request path / Response format, etc…
2. Analyze the pros. and cros.
3. Playground (optional)
4. Feedback to our API design and implementation

What is RESTful API ?

1. 符合 REST 架構設計的 API
2. 符合: 六大目標所衍伸出來的五大特徵

Review: What is REST ?

1. http://whatisrest.com/
2. The 6 goals for implement RESTful API:
   1. Simplicity
   2. Scalability
   3. Reliability
   4. Performance
   5. Modifiability
   6. Visibility

Review: What is REST ?

1. Simplicity
   1. 如何讓架構的複雜度低
2. Scalability
   1. 如何在需求量暴增的情況下，也不影響服務結果
3. Reliability
   1. 如何在架構中部分損壞時，也不影響服務
4. Performance
   1. 如何不受網路傳輸限制，而影響回傳結果的時間

Review: What is REST ?

1. Modifiability
   1. 如何在對部分架構做更動時，也不影響服務
2. Visibility
   1. 如何讓傳輸過程中，可以看出所請求的服務是什麼，進而達到幫助完成服務的目標

Review: What is REST ?

1. The 5 constraints (or characteristics):
   1. Client-Server

Review: What is REST ?

1. The 5 constraints (or characteristics):
   1. Client-Server
      1. Scalability: 依據不同 Request 可以做不同的擴充
      1. 例如: Elasticsearch 相關的服務需要擴充，新增 Elasticsearch Node
      2. Modifiability: 更動單一個 API，不影響其他的
   2. Layered System

Review: What is REST ?

1. The 5 constraints (or characteristics):
   1. Layered System
      1. Scalability: 服務分層，依據需要的層級做擴充
      2. Modifiability: 修改單一層級，不影響服務
      3. Visibility: 要達到分層，需要讓傳輸過程的 Request / Response 是可以被解析的
      4. Simplicity: 適當分工

Review: What is REST ?

1. The 5 constraints (or characteristics):
   1. Interface / Uniform Contract
      1. 建立共通的合約
      1. 例如: Request 有 Lasutung 這個字時，表示他要打開 Lasutung 的視訊
      2. Simplicity: 不需要對每個 Request 客製化
      3. Modifiability: 知道合約的各方，可以獨立修改自己的部分而不影響其他合約方
      4. Visibility: 在傳輸過程中，都可以透過合約來檢視這個 Request 的需求或是 Response 的大致含義

Review: What is REST ?

1. The 5 constraints (or characteristics):
   1. Stateless

Review: What is REST ?

1. The 5 constraints (or characteristics):
   1. Stateless
      1. Scalability: 不用處理 Request 狀態被存在哪裡的問題
      2. Modifiability: 不用擔心修改 Request 會對個別的使用者造成怎樣的影響
      3. Visibility: Request 所需資訊會一次帶齊，中介者可以解析出該 Request 確切的請求
      4. Reliability: 部分 Server 服務中斷時，還是可以回應 Request

Review: What is REST ?

1. The 5 constraints (or characteristics):
   1. Cache
      1. Scalability: 不是所有流量都直接進到 Server
      2. Performance: 經過的網路傳輸路徑短，回傳時間短

The Affection to API Design

Interface / Uniform Contract

1. HTTP Method

The Effection to the API Design

Interface / Uniform Contract

1. Resource Name

			GET /users
			GET /users/lasutung
			POST /news
			PUT /news/1
			DELETE /users/lasutung/news/1 ??
			DELETE /news/1 # Simplicity
			DELETE /news/1,2,3
		

The Effection to the API Design

Interface / Uniform Contract

1. HTTP Response
   1. 2xx: Success
   2. 3xx: Redirection
   3. 4xx: Client Errors
   4. 5xx: Service Errors
2. http://www.restapitutorial.com/httpstatuscodes.html

The Effection to the API Design

Interface / Uniform Contract

1. Response Payload
   1. JSON
   2. Error Message
   3. Pagination
   4. ...

The Effection to the API Design

1. Idempotent: Can do it over and over again without causing different results

Firebase

Founded on Apr 6, 2011

Firebase Realtime Database API

HTTP Method

Firebase Realtime Database API

1. Resource Name

			https://{your-project-name}.firebaseio.com
			/{your-firebase-model-lv-1}
			/{your-firebase-model-lv-2}
			...
			.json
		

Firebase Realtime Database API

1. HTTP Status Code
   1. Success: 200 OK

Firebase Realtime Database API

1. HTTP Status Code
   1. Success: 200 OK
   2. Error:

Firebase Realtime Database API

1. Response Payload
   1. Success:

Firebase Realtime Database API

1. Response Payload
   1. Success:
   2. Error:

Pros and Cons

1. Pros
   1. 使用 HTTP Status Code 做溝通
   2. 一致用 200 代表成功，不會有其他 2xx 的可能
   3. Payload 有 error 的 Key 時，HTTP Status Code 必定不是 2xx

Pros and Cons

1. Pros
   1. 使用 HTTP Status Code 做溝通
   2. Payload 有 error 的 Key 時，HTTP Status Code 必定不是 2xx
   3. 一致用 200 代表成功，不會有其他 2xx 的可能
2. Cons
   1. Response Payload 沒有一致的格式，一旦後台 Key 值更動，則前台會直接因為找不到 Key 而出錯

Q & A