基于HTTP標準協議的API接口設計規范構思

warmcheng 發布于2019-08-21 11:18 / 1888人閱讀

摘要：開發規范版本控制開發流程接口請求方式動作中文說明列表創建詳細更新部分更新刪除數據請求支持返回格式統一為一個請求對應一個錯誤錯誤信息包含在返回內容里不同的錯誤對應不同的錯誤信息代碼錯誤碼按照標準用法使用認證權限以中間件形式作為權限鑒別

開發規范

版本控制git

開發流程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	刪除

數據

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

返回格式統一為json

一個請求對應一個serializer

錯誤

錯誤信息包含在返回內容里

不同的錯誤對應不同的錯誤信息代碼

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

認證

jwt

token

oauth2

權限

以中間件形式作為權限鑒別插件，根據http請求格式直接判斷權限

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

日志

日志以中間件形式提供

根據業務需求氛圍入庫日志與普通日志

文檔(待完善)

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

{
  "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

服務器資源監控

待完善

云服務器 GPU云服務器分布式云服務器的設計構思 api接口規范標準api服務接口 api接口設計

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/86552.html

基于HTTP標準協議的API接口設計規范構思

摘要：開發規范版本控制開發流程接口請求方式動作中文說明列表創建詳細更新部分更新刪除數據請求支持返回格式統一為一個請求對應一個錯誤錯誤信息包含在返回內容里不同的錯誤對應不同的錯誤信息代碼錯誤碼按照標準用法使用認證權限以中間件形式作為權限鑒別開發規范版本控制git 開發流程git flow 接口請求方式 url 動作中文說明 GET /resources/ list 列表 ...

gghyoo 2019-07-25 11:14 評論0 收藏0
全棧開發自學路線

摘要：前言這里筑夢師是一名正在努力學習的開發工程師目前致力于全棧方向的學習希望可以和大家一起交流技術共同進步用簡書記錄下自己的學習歷程個人學習方法分享本文目錄更新說明目錄學習方法學習態度全棧開發學習路線很長知識拓展很長在這里收取很多人的建議以后決前言這里筑夢師,是一名正在努力學習的iOS開發工程師,目前致力于全棧方向的學習,希望可以和大家一起交流技術,共同進步,用簡書記錄下自己的學習歷程...

galaxy_robot 2019-06-28 18:47 評論0 收藏0
全棧開發自學路線

摘要：前言這里筑夢師是一名正在努力學習的開發工程師目前致力于全棧方向的學習希望可以和大家一起交流技術共同進步用簡書記錄下自己的學習歷程個人學習方法分享本文目錄更新說明目錄學習方法學習態度全棧開發學習路線很長知識拓展很長在這里收取很多人的建議以后決前言這里筑夢師,是一名正在努力學習的iOS開發工程師,目前致力于全棧方向的學習,希望可以和大家一起交流技術,共同進步,用簡書記錄下自己的學習歷程...

Scorpion 2019-08-22 16:34 評論0 收藏0