#api-doc
使用方法
####1、安装扩展
composer require weiwei/api-doc dev-master
由于我没发布版本,所有暂时需带dev-master安装
####2、配置参数 安装好扩展后在 application\extra\ 文件夹下会生成 doc.php 配置文件 在controller参数中添加对应的类
'controller' => [
'app\\api\\controller\\Demo'
]
####3、在相关接口类中增加注释参数 方法如下:返回参数支持数组及多维数组
<?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()
{
//接口代码
}
}
####4、在浏览器访问http://你的域名/doc 查看接口文档
####5、预览
代码:https://gitee.com/lyf2017/api_doc