PhalApi 2.4.2 - 接口，從簡(jiǎn)單開(kāi)始！
? 為了更好的接口開(kāi)發(fā)體驗(yàn)，2019年，重新出發(fā)！
1、開(kāi)發(fā)文檔
專為PHPer準(zhǔn)備的優(yōu)雅而詳細(xì)的開(kāi)發(fā)文檔，請(qǐng)看：PhalApi 2.x 開(kāi)發(fā)文檔。
2、在線示例
默認(rèn)接口服務(wù)：http://demo.phalapi.net/?s=App.Site.Index
在線接口文檔：http://demo.phalapi.net/docs.php
接口詳情文檔（以默認(rèn)接口為例）：http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold
PhalApi創(chuàng)新項(xiàng)目-小白接口（免費(fèi)、免開(kāi)發(fā)、直接可用的的云端API）：https://www.okayapi.com/
3、快速安裝
composer一鍵安裝
使用composer創(chuàng)建項(xiàng)目的命令，可實(shí)現(xiàn)一鍵安裝。
$ composer create-project phalapi/phalapi
溫馨提示：關(guān)于composer的使用，請(qǐng)參考Composer 中文網(wǎng) / Packagist 中國(guó)全量鏡像。
手動(dòng)下載安裝
或者，也可以進(jìn)行手動(dòng)安裝。將此Git項(xiàng)目代碼下載解壓后，進(jìn)行可選的composer更新，即：
$ composer update
4、使用
調(diào)用接口
在PhalApi，你可以通過(guò)service參數(shù)（短名字是s參數(shù)）指定需要調(diào)用的接口服務(wù)。例如，訪問(wèn)默認(rèn)接口服務(wù)。
默認(rèn)接口：http://localhost/phalapi/public/?s=App.Site.Index
溫馨提示：推薦將訪問(wèn)根路徑指向/path/to/phalapi/public。
對(duì)應(yīng)執(zhí)行的PHP代碼在./src/app/Api/Site.php文件，源碼片段如下：
<?php
namespace App\Api;
use PhalApi\Api;
/**
* 默認(rèn)接口服務(wù)類
* @author: dogstar <chanzonghuang@gmail.com> 2014-10-04
*/
class Site extends Api {
? ? public function getRules() {
? ? ? ? return array(
? ? ? ? ? ? 'index' => array(
? ? ? ? ? ? ? ? 'username'? => array('name' => 'username', 'default' => 'PhalApi', 'desc' => '用戶名'),
? ? ? ? ? ? ),
? ? ? ? );
? ? }
? ? /**
? ? * 默認(rèn)接口服務(wù)
? ? * @desc 默認(rèn)接口服務(wù)，當(dāng)未指定接口服務(wù)時(shí)執(zhí)行此接口服務(wù)
? ? * @return string title 標(biāo)題
? ? * @return string content 內(nèi)容
? ? * @return string version 版本，格式：X.X.X
? ? * @return int time 當(dāng)前時(shí)間戳
? ? * @exception 400 非法請(qǐng)求，參數(shù)傳遞錯(cuò)誤
? ? */
? ? public function index() {
? ? ? ? return array(
? ? ? ? ? ? 'title' => 'Hello ' . $this->username,
? ? ? ? ? ? 'version' => PHALAPI_VERSION,
? ? ? ? ? ? 'time' => $_SERVER['REQUEST_TIME'],
? ? ? ? );
? ? }
}
接口請(qǐng)求后結(jié)果輸出類似如下：
{
? ? "ret": 200,
? ? "data": {
? ? ? ? "title": "Hello PhalApi",
? ? ? ? "version": "2.4.2",
? ? ? ? "time": 1501079142
? ? },
? ? "msg": ""
}
運(yùn)行效果，截圖如下：
查看在線接口文檔
PhalApi會(huì)根據(jù)你編寫的接口的參數(shù)配置和代碼注釋，自動(dòng)實(shí)時(shí)生成在線接口文檔。在線接口文檔鏈接為：
在線接口文檔：http://localhost/phalapi/public/docs.php
瀏覽效果類似如下：
5、一張圖告訴你如何使用PhalApi 2.x
6、還有問(wèn)題，怎么辦？
如發(fā)現(xiàn)問(wèn)題，或者任何問(wèn)題，歡迎提交Issue到這里，或進(jìn)入PhalApi開(kāi)源社區(qū)。
如果喜歡，請(qǐng)幫忙在Github或碼云給個(gè)Star，也可以對(duì)PhalApi進(jìn)行捐贈(zèng)哦 ^_^。
