php自動生成api接口文檔,PHP開發的簡單的api接口管理系統源碼

本文目錄一覽：

• 1、php接口文檔生成工具phpdoctor怎麼用
• 2、php如何開發API接口
• 3、如何用PHP開發API接口

php接口文檔生成工具phpdoctor怎麼用

一、phpxref↑

PHPXref是一個易用級的PHP項目文檔生成工具，它生成Html的文檔—-結構清晰、明了。PHPXref可以方便的在不同平台下（Linux with Perl，Win32 with EXE）幫助你生成某一目錄下所有php文件的“資源”索引文檔。這些“資源”，包括：Class（類）、Function（函數）、Variable（變量）、Constant（常量）…..。PHPXref給我們列出了這些資源的定義與引用的詳細情況。我們可以很方便地找到某一個函數（變量）在何處被定義，在何處被調用（引用）。 這裡以Wordpress為例，它能Wordpress中所有的函數、變量、常量等分類記錄，生成一個HTML網頁列表，你可以輕鬆地在這個列表中找到某個函數在什麼位置被定義，在什麼位置被引用。如果你是Wordpress插件開發者或者想學習研究Wordpress的人，項目文檔的作用比較明顯。 PHPXref官方有個已經製作好的Wordpress的分析文檔：，此外，PHPXref還製作了多種PHP程序的分析文檔，有興趣的可以Google站內搜索一下。 PHPXref的主要功能包括：

文件管理。無論要找什麼文件，用它能很快地搜索到，如果你的文件中有符合語法規則的注釋，PHPXref還能將它列在文件名的旁邊，更容易了解這個文件的功能用途，也不用為了找一個文件翻遍整個文件夾，打開每個文件查找注釋了。

函數、變量、常量、類管理。Wordpress內置了多種功能強大的函數、類，無論是字符處理還是遠程URL讀取等都有現成的函數，但我們往往 不知道這個函數能在Wordpress裡面找到，現在容易多了，搜索一下就找到了，如果在開發過程中遇到某個Wordpress函數，不知道它是幹什麼用 的，這時候就得找到這個函數在哪裡定義的，可是Wordpress裡面上百個文件上哪找去？還是用PHPXref好了。

文件包含管理。Wordpress中需要很多 include，require包含別的文件，但偶爾也會遇到重複包含導致出錯，雖然require_once可以解決，但我們也最好要了解某個腳本包含 了哪些文件，要調用這個文件時也心中有數。PHPXref提供了每個文件的包含文件列表和被包含的文件。

源代碼高亮。這個功能也是比較實用的，但在實際測試中偶爾會出錯。

出色的關聯功能。在瀏覽源代碼時，將鼠標指到某個函數名，就會在鼠標旁邊出現函數的定義頁面，以及被使用次數，此外，還對使用較多的變量名，也是可以直接有個頁面顯示所有的關於這個變量的使用情況。

簡介下windows下其使用過程：

1、下載：官方網站：phpxref官方sf網站

2、使用（以下載windows版本為例）：通過以上下載你將得phpxref-0.7-win32.zip壓縮包。

步驟一：解壓phpxref-0.7-win32.zip。進入phpxref-0.7-win32（註：不用安裝的，所以你不用習慣性的去點擊.exe可執行文件），你將看一個名為：source的目錄—它很關鍵；

步驟二：複製你的項目文件到上面提到的source目錄。

步驟三：雙擊phpxref.exe；

步驟四：如果項目比較大，請耐心等待數秒鐘。

步驟五：進入和source目錄同級的output目錄，你將看到一些東西。呵呵，雙擊index.html開始觀看你的項目文檔,去嘗試吧，它能告訴你的很多哦。

PHPXref還提供了在Linux下生成文檔的版本，但我很少用，也沒有去測試了，我想更多數人需要的還是Win系統下的，如果有需要，把Win下生成的文檔可以搬到服務器上去供大家訪問。但PHPxref生成的文檔實在太大了，一個1.2MB的Wordpress(壓縮包)，解壓後再生成文檔，居然要80多 MB的位置！壓縮完後也需要接近20MB。 除了用PHPXref來生成已有的Wordpress或其他PHP示範程序（如Discuz）進行學習外，用PHPXref來生成自己製作的PHP 程序，進行檢驗錯誤或者是整理代碼資源也很有用

二、PHP Doctor↑

安裝php支持（若你有php環境支持，可以略去），設置環境變量path，把php 的安裝路徑加上，比如php 安裝在d:/php5/

下載phpdoctor，可以去官網下載把下載的壓縮包解壓到任何地方

配置phpdoctor, phpdoctor 最基本的配置，複製一個ini文件進行就該就好

//源碼路徑，比如您的源碼路徑d:work/phptest,如下設置

source_path=“d:work/phptest”

//生成的html 文檔保存路徑,默認是保存在當前目錄下apidocs(系統自動創建)，可以更改為其他目錄，比如

d = “apidocs”或 d = “d:work/doc”

生成文檔

打開你的cmd,先切換到你的phpdoctor 安裝路徑，然後執行下面代碼

php phpdoc.php config_file

php如何開發API接口

進入php源程序目錄中的ext目錄中，這裡存放着各個擴展模塊的源代碼，選擇你需要的模塊，比如curl模塊：cd curl

執行phpize生成編譯文件，phpize在PHP安裝目錄的bin目錄下

/usr/local/php5/bin/phpize

運行時，可能會報錯：Cannot find autoconf. Please check your autoconf installation and

the $PHP_AUTOCONF

environment variable is set correctly and then rerun this

script.，需要安裝autoconf：

yum install autoconf（RedHat或者CentOS）、apt-get install

autoconf（Ubuntu Linux）

/usr/local/php5/bin/php -v

執行這個命令時，php會去檢查配置文件是否正確，如果有配置錯誤，

這裡會報錯，可以根據錯誤信息去排查！

如何用PHP開發API接口

他會提供相應接口給你的，具體調用方法就相當於講求某個鏈接。act=get_user_listtype=json在這裡operate.php相當於一個接口，其中get_user_list 是一個API（獲取用戶列表），講求返回的數據類型為JSON格式。

act=get_user_listtype=json’;$ch = curl_init ();curl_setopt ( $ch, CURLOPT_URL, $url );curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 );curl_setopt ( $ch, CURLOPT_CONNECTTIMEOUT, 10 );curl_setopt ( $ch, CURLOPT_POST, 1 ); //啟用POST提交$file_contents = curl_exec ( $ch );curl_close ( $ch );