2019-05-08

ThinkPHP5如何自动生成API文档

开发接口的时候写接口文档是一个比较累的活，TP5有一个可以自动生成文档的插件，配置简单生成的文档还不错。

使用方法

安装扩展

1	composer require weiwei/api-doc dev-master

配置参数

1
2
3

'controller' => [
    'app\\api\\controller\\Demo' //安装好扩展后在 application\extra\ 文件夹下会生成 doc.php 配置文件 在controller参数中添加对应的类
]

相关接口类中增加注释参

<?php
/**
 * @title 测试demo
 * @description 接口说明
 */
class demo
{
    /**
     * @title 测试demo接口
     * @description 接口说明
     * @author 开发者
     * @url /api/demo
     *
     * @param name:id type:int require:1 default:1 other: desc:唯一ID
     *
     * @return name:名称
     * @return mobile:手机号
     * @return list_messages:消息列表@
     * @list_messages message_id:消息ID content:消息内容
     * @return object:对象信息@!
     * @object attribute1:对象属性1 attribute2:对象属性2
     * @return array:数组值#
     * @return list_user:用户列表@
     * @list_user name:名称 mobile:手机号 list_follow:关注列表@
     * @list_follow user_id:用户id name:名称
     */
    public function index()
    {
        //接口代码
    }

}