安装和简单使用apidoc

Posted 2020-12-17 DJ同学

安装nodejs

参考链接

安装apidoc

参考链接

使用

https://www.bilibili.com/video/BV1MW411Q7g4

https://www.bilibili.com/video/BV1MW411Q7Wj

https://www.cnblogs.com/luqiang213917/p/11833810.html

注意先cd到对应的路径,再去生成文档

cd /d D:\\Project\\think518

apidoc -i application/  -o mydoc/

每次修改 都需要 执行以下上的命令

/**
     *
     * @api{post} /index.php?g=App&m=AlterStorage&a=listStorage 列出该仓储员相关的仓库信息 +g控制器上面的目录 m控制器 a方法名
     * @apiSampleRequest /index.php?g=App&m=AlterStorage&a=listStorage
     * @apiName  listStorage +方法名
     * @apiGroup AlterStorage 仓储员&仓库 +控制器
     * @apiDescription  列出该仓储员相关的仓库信息 +描述
     *
     * @apiParam {String} account 账号 +I 传入
     *
     * @apiError {String} code 0
     * @apiError {String} msg 信息
     * @apiError {array} data 数据
     * @apiError {array} data.storageName 仓库名
     * @apiError {array} data.storageUuid 仓库uuid
     **/

return 和private 的方法可以不用写接口