API介面通用返回類,TP通用

2021-10-06 17:05:36 字數 1270 閱讀 7056

/*** 返回成功

* @param $msg

* @param null $data

* @return apiresponse

*/public static function success(

$msg, $data

= null)

/*** 返回錯誤

* @param $msg

* @return apiresponse

*/public static function error(

$msg

) /**

* token失效返回登入頁面

* @param $msg

* @param int $code

* @return apiresponse

*/public static function result(

$msg, $code

= 302)

/*** 獲取當前的response 輸出型別

* @access protected

* @return string

*/private function getresponsetype(

)}以上不考慮跨域訪問,如果有跨域問題可以設定header頭部,在建構函式中新增:

$header

['access-control-allow-origin']=

'*';

$header

['access-control-allow-headers']=

'x-requested-with,content-type'

;$header

['access-control-allow-methods']=

'get,post,patch,put,delete,options'

;

注意:這個頭部不能隨便新增,如果在某些公共方法中已新增過header 則此處無需新增,否則會報錯跨域。

API通用返回模型

1 2 通用返回類 3 4public class result58 訊息 9public string msg 10 業務資料 11public object data 12 13 不帶資料成功返回型別 14 15 16public static result success 1723 24 帶資...

通用返回格式

業務操作結果資訊類,對操作結果進行封裝 public class operationresult 初始化乙個 定義返回訊息的業務操作結果資訊類 的新例項 業務操作結果型別 業務返回訊息 public operationresult operationresulttype resulttype,str...

API通用設計原則

什麼是好的 api?完備 be complete 對確定重點支援的使用者場景具有完備的功能支援。就是說,使用者通過對一組 api的呼叫能夠完成預期的功能。不冗餘 be minimal 在完備的前提下,api只提供最小的功能集合。不缺少 不冗餘。簡單清晰 be clear 介面設計簡單清晰。每個介面都...