php 数据接口,初识 php 接口
這次的這篇文章介紹的是PHP接口的內(nèi)容,現(xiàn)在分享給大家,也給有需要幫助的朋友一個(gè)參考,大家一起過來看一看吧
一. 接口按請求人可以分為兩種:
一種是被其他內(nèi)部項(xiàng)目調(diào)用的接口(包括js異步請求的接口和定時(shí)程序)。
另一種是對外的接口,主要提供給外部開發(fā)者調(diào)用的。
兩種接口最大區(qū)別就是,內(nèi)部接口不需要太嚴(yán)格的身份驗(yàn)證,而對外接口需要嚴(yán)格的身份驗(yàn)證,加密解密方式各種各樣,其中最常見最簡單的就是http basic驗(yàn)證,例如我們的大后臺彈出的賬號和密碼彈窗 就是用了basic驗(yàn)證,輸入賬號和密碼才能通過驗(yàn)證。但是如果內(nèi)部接口涉及到重要的操作,不希望被他人惡意請求的話,還是要做一點(diǎn)加密驗(yàn)證的。
二. 無論是哪一種接口,都應(yīng)該考慮到下面的問題:
1.安全。參數(shù)安全:這個(gè)我們有$_INPUT基本就足夠了。是否需要身份驗(yàn)證:如果只是內(nèi)部通知類/回調(diào)類的接口的話就算被惡意請求也不會影響數(shù)據(jù)正常,這種的話可以完全不做驗(yàn)證,舉個(gè)栗子,我做個(gè)一個(gè)同步訂單狀態(tài)的接口,里面的流程是,查詢訂單狀態(tài)有問題的訂單,然后更新這些訂單的狀態(tài)。這種接口不需要返回任何值,就算被壞人惡意調(diào)用也不會有毛線影響的,那就根本沒必要做身份驗(yàn)證了。所以這個(gè)是否加驗(yàn)證是按照接口實(shí)際邏輯決定的。
2.能否重復(fù)請求。例如某個(gè)接口是根據(jù)傳入的訂單號,插入一條數(shù)據(jù),需要做好重復(fù)請求的判斷,避免插入多條數(shù)據(jù)。
三. 編寫接口規(guī)范
1. 用 try…catch…結(jié)構(gòu)去寫。(主要是 throw 可以隨時(shí)結(jié)束程序,這樣很爽~)
2. 返回狀態(tài)碼,不要返回success等于true或者false,如果要編寫文檔,關(guān)于不同錯(cuò)誤碼的含義也應(yīng)該寫明白,方便調(diào)用方查詢出錯(cuò)原因。
下面直接看栗子:<?php
$code = 200; // 接口狀態(tài)碼
$name = trim($_INPUT['name']); $age = trim($_INPUT['age']); if (empty($name))
{ $code = 401; throw new Exception('名字不能為空');
} if (!is_numeric($age))
{ $code = 402; throw new Exception('年齡必須由數(shù)字組成');
} $database_obj = new database_class(); $res = $database_obj->save($name, $age); if ( !$res )
{ $code = 403; throw new Exception('保存數(shù)據(jù)失敗');
}
$msg = 'ok';
} catch ( Exception $e ) { $msg = $e->getMessage();
}
output_json($code,$data,$msg); // $data可以放置需要返回的數(shù)據(jù)// output_json函數(shù)在大function里面有~如果不想引入大function的話可以復(fù)制一份到自己項(xiàng)目// ========END=======?>
轉(zhuǎn)載自:https://www.cnblogs.com/xiaomendelu/p/5819708.html
一. 接口按請求人可以分為兩種:
一種是被其他內(nèi)部項(xiàng)目調(diào)用的接口(包括js異步請求的接口和定時(shí)程序)。
另一種是對外的接口,主要提供給外部開發(fā)者調(diào)用的。
兩種接口最大區(qū)別就是,內(nèi)部接口不需要太嚴(yán)格的身份驗(yàn)證,而對外接口需要嚴(yán)格的身份驗(yàn)證,加密解密方式各種各樣,其中最常見最簡單的就是http basic驗(yàn)證,例如我們的大后臺彈出的賬號和密碼彈窗 就是用了basic驗(yàn)證,輸入賬號和密碼才能通過驗(yàn)證。但是如果內(nèi)部接口涉及到重要的操作,不希望被他人惡意請求的話,還是要做一點(diǎn)加密驗(yàn)證的。
二. 無論是哪一種接口,都應(yīng)該考慮到下面的問題:
1.安全。參數(shù)安全:這個(gè)我們有$_INPUT基本就足夠了。是否需要身份驗(yàn)證:如果只是內(nèi)部通知類/回調(diào)類的接口的話就算被惡意請求也不會影響數(shù)據(jù)正常,這種的話可以完全不做驗(yàn)證,舉個(gè)栗子,我做個(gè)一個(gè)同步訂單狀態(tài)的接口,里面的流程是,查詢訂單狀態(tài)有問題的訂單,然后更新這些訂單的狀態(tài)。這種接口不需要返回任何值,就算被壞人惡意調(diào)用也不會有毛線影響的,那就根本沒必要做身份驗(yàn)證了。所以這個(gè)是否加驗(yàn)證是按照接口實(shí)際邏輯決定的。
2.能否重復(fù)請求。例如某個(gè)接口是根據(jù)傳入的訂單號,插入一條數(shù)據(jù),需要做好重復(fù)請求的判斷,避免插入多條數(shù)據(jù)。
三. 編寫接口規(guī)范
1. 用 try…catch…結(jié)構(gòu)去寫。(主要是 throw 可以隨時(shí)結(jié)束程序,這樣很爽~)
2. 返回狀態(tài)碼,不要返回success等于true或者false,如果要編寫文檔,關(guān)于不同錯(cuò)誤碼的含義也應(yīng)該寫明白,方便調(diào)用方查詢出錯(cuò)原因。
下面直接看栗子:<?php
$code = 200; // 接口狀態(tài)碼
$name = trim($_INPUT['name']); $age = trim($_INPUT['age']); if (empty($name))
{ $code = 401; throw new Exception('名字不能為空');
} if (!is_numeric($age))
{ $code = 402; throw new Exception('年齡必須由數(shù)字組成');
} $database_obj = new database_class(); $res = $database_obj->save($name, $age); if ( !$res )
{ $code = 403; throw new Exception('保存數(shù)據(jù)失敗');
}
$msg = 'ok';
} catch ( Exception $e ) { $msg = $e->getMessage();
}
output_json($code,$data,$msg); // $data可以放置需要返回的數(shù)據(jù)// output_json函數(shù)在大function里面有~如果不想引入大function的話可以復(fù)制一份到自己項(xiàng)目// ========END=======?>
相關(guān)推薦:
總結(jié)
以上是生活随笔為你收集整理的php 数据接口,初识 php 接口的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: python numpy pandas
- 下一篇: php管道的概念,让你的php命令行程序