PhalApi 2.4.2 - 接口，從簡單開始！（爲了更好的接口開發體驗，2019從新出發）

PhalApi 2.4.2 - 接口，從簡單開始！

   

一、開發文檔

專爲PHPer準備的優雅而詳細的開發文檔，請看：PhalApi 2.x 開發文檔。

二、在線示例

• 默認接口服務：http://demo.phalapi.net/?s=App.Site.Index
• 在線接口文檔：http://demo.phalapi.net/docs.php
• 接口詳情文檔（以默認接口爲例）：http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold
• PhalApi創新項目-小白接口（免費、免開發、直接可用的的雲端API）：https://www.okayapi.com/

三、快速安裝

composer一鍵安裝

使用composer建立項目的命令，可實現一鍵安裝。

$ composer create-project phalapi/phalapi

舒適提示：關於composer的使用，請參考Composer 中文網 / Packagist 中國全量鏡像。

手動下載安裝

或者，也能夠進行手動安裝。將此Git項目代碼下載解壓後，進行可選的composer更新，即：

$ composer update

四、使用

調用接口

在PhalApi，你能夠經過service參數（短名字是s參數）指定須要調用的接口服務。例如，訪問默認接口服務。

• 默認接口：http://localhost/phalapi/public/?s=App.Site.Index

舒適提示：推薦將訪問根路徑指向/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會根據你編寫的接口的參數配置和代碼註釋，自動實時生成在線接口文檔。在線接口文檔連接爲：

• 在線接口文檔：http://localhost/phalapi/public/docs.php

瀏覽效果相似以下：

五、獨家贊助商

此版本由（點擊成爲）獨家贊助。

六、還有問題，怎麼辦？

如發現問題，或者任何問題，歡迎提交Issue到這裏，或進入PhalApi開源社區。
若是喜歡，請幫忙在Github或碼雲給個Star，也能夠對PhalApi進行捐贈哦 ^_^。