---
tags: Open API
---
# Open API介紹:

## :memo:
1. 定義
2. 公開的文件，詳細的說明使用方式
3. 設計 Authentication 驗證請求的合法性
4. API 文件撰寫輔助工具

### 1. 定義
Open API 簡單來說是就是一個應用程式的開口讓開發者能夠串接， 它是Server Side Web API 的應用方式，提供開發者可以透過程式去存取應用軟體或網路服務，也就是說會有公開的文件和公開的接口(end point)，讓外部應用系統得以透過這些介面存取。

### 2. 公開的文件，詳細的說明使用方式
文件寫得夠完整且清楚，就能減少和開發者的來會溝通成本。
最簡單的實現方就是開放 public 的 restful API(當然也可以包裝成SDK，方便個語言調用functionon)
範例：
1. Stripe: https://stripe.com/docs/api

2. OneSignal
https://documentation.onesignal.com/reference

### 3. 設計 Authentication 驗證請求的合法性
開發者在每次的請求都需要在request header上帶入api Key，而Open API 也須提供給開發者相對應的API key ，以確保每次的請求都是來自合法的client端
1. JWT Token
2. Baisc Auth
3. Generate custom API key

參考資料: https://stripe.com/docs/api/authentication

### 4. API 文件撰寫輔助工具
主流使用 Swagger 做API 文件撰寫
1. [Swagger](https://swagger.io/)
2. [Postman](https://www.postman.com/)