关于composer自动生成接口文档-composer-PHP中文网

关于composer自动生成接口文档

藏色散人

发布： 2020-07-03 11:50:27

转载

3156人浏览过

下面由composer教程栏目给大家介绍关于composer自动生成接口文档，希望对需要的朋友有所帮助！

关于composer自动生成接口文档

安装composer

1.先下载Composer-Setup.exe，下载地址：下载Composer 。会自动搜索PHP.exe的安装路径,如果没有，就手动找到php路径下的php.exe。

2.在PHP目录下，打开php.ini文件，开启openssl扩展。去掉extension=php_openssl.dll前面的分号(;)

3.把php目录添加到环境变量（和php.exe同级目录的路径）例如：D:pache_phpphp添加到环境变量path里。

4.下载composer.phar,下载地址：Composer.phar 将composer.phar文件放入php目录下，在php目录下新建一个文件composer.cmd，内容写成：
@php "%~dp0composer.phar" %*保存。运行这个文件，然后打开cmd运行：composer会出现
可以运行composer --version 查看composer的版本。

5.在命令行中执行：composer config -g repo.packagist composer https://packagist.phpcomposer.com

改写Packagist 镜像至国内镜像可以加快下载速度。

最后提一下，看云上有composer的中文手册http://www.kancloud.cn/thinkphp/composer

通过composer安装软件，实现自动生成接口文档（https://packagist.org/packages/weiwei/api-doc）

cmd 进入项目目录，输入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', //版权信息
    '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' => [
        //过滤 不解析的方法名称
        '_empty'
    ],
    'return_format' => [
        //数据格式
        'code' => "200/205/301/307",
        'msg' => "状态码说明",
    ],
    'public_header' => [
        //全局公共头部参数
        //['name'=>'', 'require'=>1, 'default'=>'', 'desc'=>''],
        //['name'=>'', 'require'=>1, 'default'=>'', 'desc'=>''],
    ],
    'public_param' => [
        //全局公共请求参数，设置了所有的接口会自动增加次参数
        //['name'=>'token','type'=>'字符串', 'require'=>1, 'default'=>'','other'=>'用户唯一身份标识码', 'desc'=>'token'],
        ['name'=>'sign','type'=>'字符串', 'require'=>1, 'default'=>'','other'=>'接口参数加密', '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');//短信验证码发送
Route::rule('imemsg','ios/member/memsg');//获取用户信息

登录后复制

address.php:

Text-To-Pokemon口袋妖怪

输入文本生成自己的Pokemon，还有各种选项来定制自己的口袋妖怪

查看详情

<?php
...
    /**
     * @title 首页分类商品
     * @description 首页分类商品
     * @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:价格
     *
     * @return new:新品上市@
     * @new id:商品id image:商品图片 goods_name:商品名 goods_price:价格
     *
     * @return image:图片@
     * @image
     */

登录后复制

URL输入：ip/doc

以上就是关于composer自动生成接口文档的详细内容，更多请关注php中文网其它相关文章！