API 接口書寫心得

背景：

定義 CMTeam 的生成測試、生成計劃、題目優(yōu)化（timer 觸發(fā)）的接口，接口規(guī)則同產(chǎn)品開發(fā)組（文檔可找我來?。?，建議提前閱讀如下內(nèi)容：

閱讀以下鏈接：
https://hackernoon.com/restful-api-designing-guidelines-the-best-practices-60e1d954e7c9

https://www.snyxius.com/blog/21-best-practices-designing-launching-restful-api/#.WUJcEROGOHo

編輯工具

推薦使用在線編輯：
http://editor.swagger.io/

概念

  1. API 要基于前端頁面請求，而非已有的函數(shù)模塊。凡是產(chǎn)品開發(fā)組需要調(diào)用的函數(shù)，都需要寫成 url 的形式。
  2. 資源的概念。Paper，Plan，Institution，Class，User

書寫規(guī)范

見標(biāo)準(zhǔn)文檔。

報錯指南

見標(biāo)準(zhǔn)文檔。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容