基於HTTP標準協議的API接口設計規範構思

開發規範

1. 版本控制git

2. 開發流程git flow

接口

請求方式	url	動做	中文說明
GET	/resources/	list	列表
POST	/resources/	create	建立
GET	/resources/:id	retrieve	詳細
PUT	/resources/:id	update	更新
PATCH	/resources/:id	partial_update	部分更新
DELETE	/resources/:id	destroy	刪除

數據

1. 請求支持form-date,json,x-www-form-urlencode

2. 返回格式統一爲json

3. 一個請求對應一個serializer

錯誤

1. 錯誤信息包含在返回內容裏

2. 不一樣的錯誤對應不一樣的錯誤信息代碼

3. http錯誤碼按照標準用法使用

認證

1. jwt

2. token

3. oauth2

權限

1. 以中間件形式做爲權限鑑別插件，根據http請求格式直接判斷權限

2. 用戶登陸成功時，將用戶信息與權限信息緩存保證效率

日誌

1. 日誌以中間件形式提供

2. 根據業務需求氛圍入庫日誌與普通日誌

文檔(待完善)

根據上面的接口格式寫文檔

{
  "resources": {
    "list": {
      "params": {},
      "response": {}
    },
    "create": {
      "request": {},
      "response": {}
    },
    "retrieve": {
      "response": {}
    },
    "update": {
      "request": {},
      "response": {}
    },
    "partial_update": {
      "request": {},
      "response": {}
    },
    "destroy": {}
  }
}

測試

業務所需接口測試覆蓋率100%

部署

• docker

• docker-compose

• docker-machine

• docker-swarm

服務器資源監控

待完善