composer自動(dòng)生成接口文檔的示例

這篇文章主要介紹composer自動(dòng)生成接口文檔的示例，文中介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們一定要看完！

安裝composer

1.先下載Composer-Setup.exe，下載地址：下載Composer 。會(huì)自動(dòng)搜索PHP.exe的安裝路徑,如果沒(méi)有，就手動(dòng)找到php路徑下的php.exe。

2.在PHP目錄下，打開(kāi)php.ini文件，開(kāi)啟openssl擴(kuò)展。去掉extension=php_openssl.dll前面的分號(hào)(;)

3.把php目錄添加到環(huán)境變量（和php.exe同級(jí)目錄的路徑）例如：D:\apache_php\php添加到環(huán)境變量path里。

4.下載composer.phar,下載地址：Composer.phar  將composer.phar文件放入php目錄下，在php目錄下新建一個(gè)文件composer.cmd，內(nèi)容寫(xiě)成：
@php "%~dp0composer.phar" %*保存。運(yùn)行這個(gè)文件，然后打開(kāi)cmd運(yùn)行：composer會(huì)出現(xiàn)
可以運(yùn)行composer --version 查看composer的版本。

5.在命令行中執(zhí)行：composer config -g repo.packagist composer https://packagist.phpcomposer.com

改寫(xiě)Packagist 鏡像至國(guó)內(nèi)鏡像可以加快下載速度。

最后提一下，看云上有composer的中文手冊(cè)http://www.kancloud.cn/thinkphp/composer

通過(guò)composer安裝軟件，實(shí)現(xiàn)自動(dòng)生成接口文檔（https://packagist.org/packages/weiwei/api-doc）

cmd 進(jìn)入項(xiàng)目目錄，輸入composer require weiwei/api-doc。

（TP5）/application/extra/view/doc.php：

<?php
return [
    'title' => "海泉智騰APi接口文檔(ios)",  //文檔title
    'version'=>'1.0.0', //文檔版本
    'copyright'=>'Powered By kraus', //版權(quán)信息
    'controller' => [
        //需要生成文檔的類
      'app\\ios\\controller\\Index',
      'app\\ios\\controller\\Member',
      'app\\ios\\controller\\Sms',
      'app\\ios\\controller\\Address',
      'app\\ios\\controller\\Goods',
      'app\\ios\\controller\\Cart',
      'app\\ios\\controller\\Order',
      'app\\ios\\controller\\Comment',
      'app\\admin\\controller\\GoodsNum',
    ],
    'filter_method' => [
        //過(guò)濾 不解析的方法名稱
        '_empty'
    ],
    'return_format' => [
        //數(shù)據(jù)格式
        'code' => "200/205/301/307",
        'msg' => "狀態(tài)碼說(shuō)明",
    ],
    'public_header' => [
        //全局公共頭部參數(shù)
        //['name'=>'', 'require'=>1, 'default'=>'', 'desc'=>''],
        //['name'=>'', 'require'=>1, 'default'=>'', 'desc'=>''],
    ],
    'public_param' => [
        //全局公共請(qǐng)求參數(shù)，設(shè)置了所有的接口會(huì)自動(dòng)增加次參數(shù)
        //['name'=>'token','type'=>'字符串', 'require'=>1, 'default'=>'','other'=>'用戶唯一身份標(biāo)識(shí)碼', 'desc'=>'token'],
        ['name'=>'sign','type'=>'字符串', 'require'=>1, 'default'=>'','other'=>'接口參數(shù)加密', 'desc'=>'簽名'],
    ],
];

route.php:

<?php
use think/Route;
Route::pattern('id','\d+');
Route::pattern('name','\w+');
Route::rule('createSign','ios/member/createSign');//生成token接口
Route::rule('iToken','ios/member/createToken');//生成token接口
Route::rule('iSendSms','ios/sms/send');//短信驗(yàn)證碼發(fā)送
Route::rule('imemsg','ios/member/memsg');//獲取用戶信息

address.php:

<?php
...
    /**
     * @title 首頁(yè)分類商品
     * @description 首頁(yè)分類商品
     * @author tiny
     * @url /itypeGoods
     * @method POST
     *
     * @param name:tid type:int require:1 default: other: desc:商品類型id
     *
     * @return type:類型@
     * @type id:類型id  cat_name:類型名
     *
     * @return recommend:推薦@
     * @recommend id:商品id image:商品圖片 goods_name:商品名 goods_price:價(jià)格
     *
     * @return new:新品上市@
     * @new id:商品id image:商品圖片 goods_name:商品名 goods_price:價(jià)格
     *
     * @return image:圖片@
     * @image
     */

URL輸入：ip/doc

以上是“composer自動(dòng)生成接口文檔的示例”這篇文章的所有內(nèi)容，感謝各位的閱讀！希望分享的內(nèi)容對(duì)大家有幫助，更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！