[toc]
# 入參
> 服務器接收的參數

# 出參
> 服務器返回的參數

# 功能說明
> 該接口的主要作用, 以及相關的代碼邏輯

# 上游接口
> 為當前接口提供數據的接口

# 下游接口
> 依賴當前接口提供數據的接口
# 接口順序
> 上游接口, 連接下游接口, 形成邏輯閉環
1. 添加數據接口
1. 獲取數據接口
1. 編輯數據接口
1. 刪除數據接口
# 參數類型
> 參數的數據類型
1. string
1. int
1. float
1. array

# 請求方法
> http方法
1. GET(SELECT):從服務器取出資源(一項或多項)。
1. POST(CREATE):在服務器新建一個資源。
1. PUT(UPDATE):在服務器更新資源(客戶端提供改變后的完整資源)。
1. DELETE(DELETE):從服務器刪除資源。

# 請求路徑
> URL, 用來尋找服務器
> 如果報500錯誤, 首先檢查URL是否正確


# 狀態碼
> 用以表示網頁服務器HTTP響應狀態的3位數字代碼
* 2XX: 成功,操作被成功接收并處理 `200`
* 3XX: 重定向,需要進一步的操作以完成請求 `301`
* 4XX: 客戶端錯誤,請求包含語法錯誤或無法完成請求 `404`
* 5XX: 服務器錯誤,服務器在處理請求的過程中發生了錯誤 `500`

# 錯誤碼
> 出參的一種, 快速定位問題

# 接口大致流程
```[sequence]
participant APP as app
participant 服務器 as server
participant 接口邏輯代碼 as python
participant 數據庫 as db
app->server:請求接口, 通過URL尋找服務器
note over app, server: 如果沒有找到服務器(URL不正確)或者服務器出錯\n則返回狀態碼
server->python: 把接收到的數據交給邏輯代碼
python->python: 接收數據, 進行邏輯處理
note over server, python : 接口驗證, 如果參數有問題, 返回錯誤碼\n如果沒問題, 則根據url里的參數, 把數據分配給不同的代碼\n如果邏輯處理時出錯, 也返回錯誤碼
python->db: 根據不同請求, 如有需要, 操作數據庫
db-->python:返回操作結果
python->python:處理數據
note over db,python: 如果數據有誤或者操作數據庫失敗\n返回錯誤碼
python-->server:通過服務器原路返回給app
server-->app:返回json數據
app->app:展示給用戶
```
- 打造高逼格接口管理平臺
- 開篇
- 課程簡介
- 聊聊接口平臺
- 接口平臺簡介
- 優雅的使用看云
- 接口和markdown
- 接口文檔版本演進
- 微軟的硬菜--vscode
- markdown基礎語法
- markdown進階語法--流程圖
- markdown進階語法--時序圖
- markdown進階語法--API文檔
- 接口文檔的基本概念
- 接口管理平臺的基本元素
- 編寫接口文檔并且發布更新
- 接口安全
- 文檔安全
- 接口安全
- Git化你的文檔
- 使用Git管理文檔
- 自動化
- 自動化文檔更新
- 收尾
- 如何反饋問題
- 課程總結
- 示例
- 更新信息
- 查詢歷史天氣
- markdown語法示例
- 流程圖示例
- 時序圖示例
- 登錄/注冊
- 數據字典示例
- 課程問題解答