成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

基于HTTP標(biāo)準(zhǔn)協(xié)議的API接口設(shè)計規(guī)范構(gòu)思

gghyoo / 1107人閱讀

摘要:開發(fā)規(guī)范版本控制開發(fā)流程接口請求方式動作中文說明列表創(chuàng)建詳細(xì)更新部分更新刪除數(shù)據(jù)請求支持返回格式統(tǒng)一為一個請求對應(yīng)一個錯誤錯誤信息包含在返回內(nèi)容里不同的錯誤對應(yīng)不同的錯誤信息代碼錯誤碼按照標(biāo)準(zhǔn)用法使用認(rèn)證權(quán)限以中間件形式作為權(quán)限鑒別

開發(fā)規(guī)范

版本控制git

開發(fā)流程git flow

接口
請求方式 url 動作 中文說明
GET /resources/ list 列表
POST /resources/ create 創(chuàng)建
GET /resources/:id retrieve 詳細(xì)
PUT /resources/:id update 更新
PATCH /resources/:id partial_update 部分更新
DELETE /resources/:id destroy 刪除
數(shù)據(jù)

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

返回格式統(tǒng)一為json

一個請求對應(yīng)一個serializer

錯誤

錯誤信息包含在返回內(nèi)容里

不同的錯誤對應(yīng)不同的錯誤信息代碼

http錯誤碼按照標(biāo)準(zhǔn)用法使用

認(rèn)證

jwt

token

oauth2

權(quán)限

以中間件形式作為權(quán)限鑒別插件,根據(jù)http請求格式直接判斷權(quán)限

用戶登錄成功時,將用戶信息與權(quán)限信息緩存保證效率

日志

日志以中間件形式提供

根據(jù)業(yè)務(wù)需求氛圍入庫日志與普通日志

文檔(待完善)

根據(jù)上面的接口格式寫文檔

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

業(yè)務(wù)所需接口測試覆蓋率100%

部署

docker

docker-compose

docker-machine

docker-swarm

服務(wù)器資源監(jiān)控

待完善

文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/38284.html

相關(guān)文章

  • 基于HTTP標(biāo)準(zhǔn)協(xié)議API接口設(shè)計規(guī)范構(gòu)思

    摘要:開發(fā)規(guī)范版本控制開發(fā)流程接口請求方式動作中文說明列表創(chuàng)建詳細(xì)更新部分更新刪除數(shù)據(jù)請求支持返回格式統(tǒng)一為一個請求對應(yīng)一個錯誤錯誤信息包含在返回內(nèi)容里不同的錯誤對應(yīng)不同的錯誤信息代碼錯誤碼按照標(biāo)準(zhǔn)用法使用認(rèn)證權(quán)限以中間件形式作為權(quán)限鑒別 開發(fā)規(guī)范 版本控制git 開發(fā)流程git flow 接口 請求方式 url 動作 中文說明 GET /resources/ list 列表 ...

    warmcheng 評論0 收藏0
  • 全棧開發(fā)自學(xué)路線

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

    galaxy_robot 評論0 收藏0
  • 全棧開發(fā)自學(xué)路線

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

    Scorpion 評論0 收藏0

發(fā)表評論

0條評論

gghyoo

|高級講師

TA的文章

閱讀更多
最新活動
閱讀需要支付1元查看
<