lsclh/apidoc

There is no license information available for the latest version (v1.1.1) of this package.

根据fastadmin的文档自动生成思想,借用其模版适配的接口文档自动生成工具

v1.1.1 2019-04-18 02:13 UTC

Unknown License

• cheng

README

#Api文档自动生成

注释功能说明

类注释
@ApiSector          类名称(必须)
@ApiRoute           类访问路径(必须)           如:  /api/index (/模块/控制器)


方法注释
@ApiTitle	    API接口的标题(必须)	     如:  登入授权接口
@ApiSummary         API接口的简介(选填)        如:  用户登入授权使用,获取token,用来调取其他接口口令
@ApiRoute           API方法名(必须)           如:  /login
@ApiMethod          API请求方式(选填)         如:  POST (默认GET)
@ApiParams          API请求参数(选填)         如:  {"name":"username","description":"用户账号","required":"是","type":"string"} 多个参数写多@ApiParams即可  type类型支持 int float 生成number input file生成文件input 其他生成text
@ApiReturn          API返回结果示例(选填)      如:  {"code":1,"msg":"订单创建成功","time":"1547608948","data":{"order_num":"201901161122291547608949100241"}}
@ApiReturnParams    API返回参数说明(选填)      如:   {"name":"token","description":"返回口令","required":"是","type":"string"} 多个参数写多个@ApiParams即可
@ApiInternal	    此方法或类将不加入文档(选填)	    无
@Update             此方法正在开发中                   无

登录接口示例

/**
 * @ApiSector 用户信息模块
 * @ApiRoute /api/user
 */
class User
{

    /**
     * @ApiTitle 用户登入
     * @ApiSummary 用户登入授权使用,获取token,用来调取其他接口口令
     * @ApiRoute /login
     * @ApiMethod POST
     * @ApiParams {"name":"username","description":"用户账号/手机号","required":"是","type":"int"}
     * @ApiParams {"name":"password","description":"用户密码","required":"是","type":"string"}
     * @ApiReturn {"code":200,"msg":"登入成功","data":{"token":"c9374c04-07be-4bd2-9e66-267eae37b35f"}}
     * @ApiReturnParams {"name":"token","description":"接口调用口令,登入成功必定返回","required":"是","type":"string"}
     */
    public function login(){

    }
}

###使用方法

1 复制目录下的ApiDoc 到启动目录

2 修改或直接使用命令行生成 php7 ApiDoc App/HttpController/Api Api.html /Temp/ApiDoc/ 项目名 作者