yangsl/apidoc

yii2-apidoc

v1.0.8 2018-08-06 08:19 UTC

MIT

• yangsl

README

yii2 apidoc

根据注释或者定义的对象文件生成接口文档。

yii2 basic版本 测试通过 yii2 advance版本 测试通过

Installation

The preferred way to install this extension is through composer.

composer require yangsl/apidoc

config add to modules

    'api-document' => [
        'class' => 'yangsl\apidoc\Module',
        'defaultRoute' => 'default', //默认控制器
        'appFolder' => 'admin',
        'appControllers' => true, //是否检测app\controllers命名空间下的控制器
        'modules' => [  //需要生成文档的模块命名空间
            'app\modules\test\Module',
        ],
    ],

访问

http://domain/api-document

注释

    /**
     * 这是一个测试的Api
     * @desc 列举所有的注释格式
     *
     * @param string $user_type |用户类型|true||其他说明|
     * @param int $sex |性别|true|0|0:不限 1:男 2:女|
     *
     * @return int status 操作码，0表示成功
     * @return string msg 提示信息
     * @return array list 用户列表
     * @return int list[].id 用户ID
     * @return string list[].name 用户名字
     *
     * @exception 400 参数传递错误
     * @exception 500 服务器内部错误
     */

or

    /**
     * 这是一个测试的Api
     * @desc 列举所有的注释格式
     *
     * @apidoc \app\structs\DemoRequest
     *
     * @exception 400 参数传递错误
     * @exception 500 服务器内部错误
     */