初識 php 接口

這次的這篇文章介紹的是PHP介面的內容，現在分享給大家，也給有需要幫助的朋友一個參考，大家一起過來看吧

一.介面依請求人可以分為兩種：
　　一種是被其他內部專案呼叫的介面（包括js非同步請求的介面和定時程式）。
　　另一種是對外的接口，主要提供給外部開發者調用的。
　　
　　兩種介面最大差別就是，內部介面不需要太嚴格的身份驗證，而對外介面需要嚴格的身份驗證，加密解密方式各種各樣，其中最常見最簡單的就是http basic驗證，例如我們的大後台彈出的帳號和密碼彈跳窗就是用了basic驗證，輸入帳號和密碼才能通過驗證。但是如果內部介面涉及到重要的操作，不希望被他人惡意要求的話，還是要做一點加密驗證的。
　　
二. 無論是哪一種接口，都應該考慮到下面的問題：
1.安全。參數安全：這個我們有$_INPUT基本上就夠了。是否需要身份驗證：如果只是內部通知類/回調類的接口的話就算被惡意請求也不會影響數據正常，這種的話可以完全不做驗證，舉個栗子，我做個一個同步訂單狀態的接口，裡面的流程是，查詢訂單狀態有問題的訂單，然後更新這些訂單的狀態。這種介面不需要回傳任何值，就算被壞人惡意呼叫也不會有毛線影響的，那就根本沒必要做身份驗證了。所以這個是否加驗證是按照介面實際邏輯決定的。

2.能否重複請求。例如某個介面是根據傳入的訂單號，插入一條數據，需要做好重複請求的判斷，避免插入多條數據。

三. 寫介面規格
1. 用 try…catch…結構去寫。 （主要是throw 可以隨時結束程序，這樣很酷~）
2. 返回狀態碼，不要返回success等於true或者false，如果要編寫文檔，關於不同錯誤碼的含義也應該寫明白，方便調用方查詢出錯原因。
下面直接看栗子：

<?php
    $code = 200; // 接口状态码 

    $name = trim($_INPUT[&#39;name&#39;]);    $age  = trim($_INPUT[&#39;age&#39;]);    if (empty($name))
    {        $code = 401;        throw new Exception(&#39;名字不能为空&#39;);
    }    if (!is_numeric($age))
    {        $code = 402;        throw new Exception(&#39;年龄必须由数字组成&#39;);
    }    $database_obj = new database_class();    $res = $database_obj->save($name, $age);    if ( !$res )
    {        $code = 403;        throw new Exception(&#39;保存数据失败&#39;);
    }    
        $msg = &#39;ok&#39;;
    } catch ( Exception $e ) {        $msg = $e->getMessage();
    }
output_json($code,$data,$msg); // $data可以放置需要返回的数据// output_json函数在大function里面有~如果不想引入大function的话可以复制一份到自己项目// ========END=======?>

轉載自：https://www.cnblogs.com/xiaomendelu/p/5819708.html

#1 介面按請求人可以分為兩種：
　　一種是被其他內部專案呼叫的介面（包括js非同步請求的介面和定時程式）。
　　另一種是對外的接口，主要提供給外部開發者調用的。
　　
　　兩種介面最大差別就是，內部介面不需要太嚴格的身份驗證，而對外介面需要嚴格的身份驗證，加密解密方式各種各樣，其中最常見最簡單的就是http basic驗證，例如我們的大後台彈出的帳號和密碼彈跳窗就是用了basic驗證，輸入帳號和密碼才能通過驗證。但是如果內部介面涉及到重要的操作，不希望被他人惡意要求的話，還是要做一點加密驗證的。
　　
二. 無論是哪一種接口，都應該考慮到下面的問題：
1.安全。參數安全：這個我們有$_INPUT基本上就夠了。是否需要身份驗證：如果只是內部通知類/回調類的接口的話就算被惡意請求也不會影響數據正常，這種的話可以完全不做驗證，舉個栗子，我做個一個同步訂單狀態的接口，裡面的流程是，查詢訂單狀態有問題的訂單，然後更新這些訂單的狀態。這種介面不需要回傳任何值，就算被壞人惡意呼叫也不會有毛線影響的，那就根本沒必要做身份驗證了。所以這個是否加驗證是按照介面實際邏輯決定的。

2.能否重複請求。例如某個介面是根據傳入的訂單號，插入一條數據，需要做好重複請求的判斷，避免插入多條數據。

三. 寫介面規格
1. 用 try…catch…結構去寫。 （主要是throw 可以隨時結束程序，這樣很酷~）
2. 返回狀態碼，不要返回success等於true或者false，如果要編寫文檔，關於不同錯誤碼的含義也應該寫明白，方便調用方查詢出錯原因。
下面直接看栗子：

<?php
    $code = 200; // 接口状态码 

    $name = trim($_INPUT[&#39;name&#39;]);    $age  = trim($_INPUT[&#39;age&#39;]);    if (empty($name))
    {        $code = 401;        throw new Exception(&#39;名字不能为空&#39;);
    }    if (!is_numeric($age))
    {        $code = 402;        throw new Exception(&#39;年龄必须由数字组成&#39;);
    }    $database_obj = new database_class();    $res = $database_obj->save($name, $age);    if ( !$res )
    {        $code = 403;        throw new Exception(&#39;保存数据失败&#39;);
    }    
        $msg = &#39;ok&#39;;
    } catch ( Exception $e ) {        $msg = $e->getMessage();
    }
output_json($code,$data,$msg); // $data可以放置需要返回的数据// output_json函数在大function里面有~如果不想引入大function的话可以复制一份到自己项目// ========END=======?>

轉載自：https://www.cnblogs.com/xiaomendelu/p/5819708.html

相關推薦：

php介面程式設計詳解

php介面如何正確使用

以上是初識 php 接口的詳細內容。更多資訊請關注PHP中文網其他相關文章！