開源介面框架 PhalApi 2.7.0 - 介面,從簡單開始!
阿新 • • 發佈:2019-12-31
PhalApi 2.7.0 - 介面,從簡單開始!
1、開發檔案
專為PHPer準備的優雅而詳細的開發檔案,請看:PhalApi 2.x 開發檔案。
2、線上示例
- 預設介面服務:demo.phalapi.net/?s=App.Site…
- 線上介面檔案:demo.phalapi.net/docs.php
- 介面詳情檔案(以預設介面為例):demo.phalapi.net/docs.php?se…
- PhalApi創新專案-小白介面(免費、免開發、直接可用的的雲端API):www.okayapi.com/
3、快速安裝
composer一鍵安裝
使用composer建立專案的命令,可實現一鍵安裝。
$ composer create-project phalapi/phalapi
複製程式碼
溫馨提示:關於composer的使用,請參考Composer 中文網 / Packagist 中國全量映象。
手動下載安裝
或者,也可以進行手動安裝。將此Git專案程式碼下載解壓後,進行可選的composer更新,即:
$ composer update
複製程式碼
4、使用
呼叫介面
在PhalApi,你可以通過service引數(短名字是s引數)指定需要呼叫的介面服務。例如,訪問預設介面服務。
溫馨提示:推薦將訪問根路徑指向/path/to/phalapi/public。
對應執行的PHP程式碼在./src/app/Api/Site.php檔案,原始碼片段如下:
<?php
namespace App\Api;
use PhalApi\Api;
/**
* 預設介面服務類
* @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' => '使用者名稱'),),);
}
/**
* 預設介面服務
* @desc 預設介面服務,當未指定介面服務時執行此介面服務
* @return string title 標題
* @return string content 內容
* @return string version 版本,格式:X.X.X
* @return int time 當前時間戳
* @exception 400 非法請求,引數傳遞錯誤
*/
public function index() {
return array(
'title' => 'Hello ' . $this->username,'version' => PHALAPI_VERSION,'time' => $_SERVER['REQUEST_TIME'],);
}
}
複製程式碼
介面請求後結果輸出類似如下:
{
"ret": 200,"data": {
"title": "Hello PhalApi","version": "2.4.2","time": 1501079142
},"msg": ""
}
複製程式碼
執行效果,截圖如下:
檢視線上介面檔案
PhalApi會根據你編寫的介面的引數配置和程式碼註釋,自動實時生成線上介面檔案。線上介面檔案連結為:
瀏覽效果類似如下:
5、一張圖告訴你如何使用PhalApi 2.x
6、子專案
7、還有問題,怎麼辦?
如發現問題,或者任何問題,歡迎提交Issue到這裡,或進入PhalApi開源社群。
如果喜歡,請幫忙在Github或碼雲給個Star,也可以對PhalApi進行捐贈哦 ^_^。