### 接口編寫規范 #### 返回值的規范 ``` json { 'code':200, "message":"", "data":[ { "title":"xxx", "content":"xxx", }, { "title":"xxx", "content":"xxx", } ] } { 'code':200, "message":"", "data":{ "title":"xxx", "content":"xxx", }, } ``` #### 狀態碼的規范 1.200：成功 2.401:沒有授權 3.400:參數錯誤 4.500:服務器內部錯誤 --- 實例: 定義好規范類接口 ``` # coding:utf-8 from flask import jsonify # 定義狀態碼 class HttpCode(object): ok = 200 paramserror = 400 unautherror = 401 servererror = 500 def restful_result(code,message,data): return jsonify({ "code":code, "message":message, "data":data, }) def success(message="",data=None): return restful_result(code=HttpCode.ok,message=message,data=data) def unauth_error(message=""): return restful_result(code=HttpCode.unautherror,message=message,data=None) def params_error(message=""): return restful_result(code=HttpCode.paramserror,message=message,data=None) def server_error(message=""): return restful_result(code=HttpCode.servererror,message=message or '服務器內部錯誤',data=None) ``` ``` # return jsonify({"code":400,"message":"舊密碼錯誤"}) return restful.params_error('舊密碼錯誤!') 這樣能夠讓代碼更加規范，減少重復寫代碼 ```