laravel 中使用apidoc

最新推荐文章于 2024-05-11 09:57:37 发布

逆鱼顺叶

最新推荐文章于 2024-05-11 09:57:37 发布

阅读量629

点赞数

分类专栏： api文档文章标签： apidoc

本文链接：https://blog.csdn.net/qq_39870660/article/details/102757741

版权

1 篇文章 0 订阅

订阅专栏

第一步：使用：npm install apidoc -g 命令全局安装apidoc

第二步：在项目根目录下新建apidoc.json文件，文件内容合适参考如下：

{
  "name": "名称",
  "version": "1.0.0",
  "description": "内幕",
  "apidoc": {
    "title": "laravel5 API文档",
    "url" : "http:/IP地址/年后/public/"
  }
}

第三步：使用apidoc -i myapp/ -o apidoc/ -t mytemplate

1. 其中 -i 表示输入，后面的文件夹路径

2. 其中 -o 表示输出，后面是文件夹路径

3. 默认会带上 -c ，在当前路径下寻找配置文件（apidoc.json）,如果找不到则会在package.josn中寻找 "apidoc":{}

4. myapp/ 表示要生成的api的源文件所在目录位置

5. mytemplete/ 表示要生成api 到的目录位置

如：apidoc -i app/Http/Controllers/Api/ -o public/apidoc

关注