因為是介面框架，首先要做的就是制定介面規範，好的介面規範能約束開發人員，能降低前後端人員之間的溝通協調，能避免後期聯調帶來的一系列問題。
1.介面規範
介面規範包含以下內容：
1、請求型別及引數
2、返回值及返回碼
3、許可權及版本控制
4、介面示例
2.介面請求說明
api使用restful風格，介面位址（測試）：http://host:port
（介面描述中位址需要擴充套件自此位址，如/api/users/register，擴充套件後則為 http://host:port/api/users/register）
介面請求型別分為兩種，get和post，get通常為請求獲取資源；post通常為提交資源到伺服器；
介面請求返回值基本分為兩種：
get的請求若無錯誤，則返回所需資源的json格式內容，若有錯誤則返回一致的json格式內容，如：}，其中data為額外的物件，具體值根據介面而定；
post的請求的body部分可以將物件格式化為json的字串後提交，也可以使用傳統的form表單形式提交， 返回一致的json格式內容：如：}，其中data的內容也是具體根據介面而定。
返回碼說明：
200 請求成功
400 客戶端請求時所提交的引數不正確（通常為客戶端的問題）
401 未提供accesstoken（即未登入）
403 許可權不足（已登入，但不具有訪問該資源的許可權）
404 找不到該資源（通常為請求的位址不正確）
500 服務發生錯誤（通常為服務端的問題）
10001 儲存成功
10002 刪除成功
10003 操作成功
10004 審核成功
失敗類20001 操作失敗
20002 **已存在
30001 無許可權
30002 系統錯誤
30003 引數錯誤
30004 路徑不存在
5.介面示例
介面示例.png
上述是登入介面的文件標識
總結設計介面規範是乙個相當複雜的事情，要綜合考慮很多技術及實現細節。後續章節依次講述這些細節，並不斷完善規範文件。
從零搭建自己的SpringBoot後台框架 六
io.springfox springfox swagger2 2.4.0 io.springfox springfox swagger ui 2.4.0 複製 在資料夾configurer中建立swaggerconfigurer package com.example.demo.core.conf...
vue 從零搭建專案
本地開發需要哪些工具 node.js 4.x,6.x preferred 以及npm包管理器。可以使用國內 的cnpm webpack前端構建工具，將vue 模板編譯打包處理的工具 webpack是當下最熱門的前端資源模組化管理和打包工具，它可以將很多鬆散的模組按照以來以及一定的規則打包成符合生產環...
從零搭建react專案
1，新建乙個空白資料夾 本文的資料夾boke cd到該目錄，開始初始化，這裡用yarn yarn init 或者 npm init y一路enter之後會生成乙個package.json檔案，內容如下 keywords author license isc 2，安裝webpack，為了避免出現不可知...