後端開發 flask響應體介面標準化

2021-10-07 18:15:05 字數 1395 閱讀 2240

基本設想:

其中code代表響應狀態碼,msg傳遞結果資訊或異常資訊,data用於返回響應資料。

# -*- coding: utf-8 -*-#

# name: response_body

# description:

# author: lty

# date: 2020/6/24

from flask import jsonify

# 響應**類:

class responsecode(object):

success = 200 # 成功

fail = -1 # 失敗

not_found = 404 # 未找到相關資訊

error = 500

# 響應體類:

class resbody(object):

"""封裝響應體

"""def __init__(self, data={}, code=responsecode.success,

msg="success"):

self._data = data

self._msg = msg

self._code = code

def update(self, code=none, data=none, msg=none):

"""更新預設響應文字

:param code:響應狀態碼

:param data: 響應資料

:param msg: 響應訊息

:return:

"""if code is not none:

self._code = code

if data is not none:

self._data = data

if msg is not none:

self._msg = msg

@property

def body(self):

"""輸出響應文字內容

:return:

"""temp = self.__dict__

temp["data"] = temp.pop("_data")

temp["msg"] = temp.pop("_msg")

temp["code"] = temp.pop("_code")

return jsonify(temp)

class notfoundexception(exception):

def __init__(self, errorinfo):

self.errorinfo = errorinfo

def __str__(self):

return self.errorinfo

前後端介面規範 通用響應格式3

引數無效 狀態碼 409 響應格式 欄位名稱 message 錯誤原因 message 不屬於任何欄位的錯誤,如實體當前狀態不允許操作,可選 errorid 如果有全域性的錯誤,可選擇性提供errorid便於後續問題排查,可選 關於欄位名稱 在409的響應中,fields陣列中的每一項都會有fiel...

Flask 設定個性化的響應體 響應頭 狀態碼

在api設計中,基於restful的設計原則,乙個http的響應應該包含執行的響應資訊以及狀態碼。例如 乙個錯誤資訊的響應資訊應該包含內容以及返回對應的設計錯誤碼。在flask中如何制定這個的響應資訊呢?下面來看看。return 響應體,狀態碼,響應頭 等價於return 響應體,狀態碼,響應頭 r...

前後端分離模式,後端說開發完才能給介面文件,合理嗎

背景 本人所在的專案組做專案過程中,後端不會先給出介面文件,而是要等他開發完介面才給出 swagger 文件。作為前端,我的想法是先有文件,就可以確定後端給到的引數,資料結構,對比和我預想的是否一致 我希望能更早發現介面是否滿足需求 是否少引數等問題 我並不指望定了文件就不改。相反,我希望早點發現早...