laravel apidoc工具使用

apidoc是一种风格优雅的API文档生成工具。

第一步:安装nodejs

curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -  
sudo apt-get install -y nodejs

注意:此处需要下载一个依赖工具:
sudo apt-get install -y build-essential

查看是否安装成功
nodejs -v
npm -v 

第二步:安装apidoc

npm install apidoc -g
apidoc -v

查看命令路径
whereis apidoc

第三步:将apidoc加入全局变量

修改/etc/profile文件,在最后加上下面代码即可
export PATH="$PATH:/usr/local/bin/apidoc"
保存,并执行
source /etc/profile

第四步:代码注释格式说明

官方文档

第五步:配置apidoc.json文件

{ 
  "name": "laravel5 API文档", 
  "version": "0.1.0", 
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title", 
  "url" : "localhost:10199/doc"
  //此处文档的生成是在public/doc下,所以url配置是这样,其他就自行修改
}

第六步:生成文档

#将laravel目录下的控制器生成api文档,命令如下:
apidoc -i app/Http/Controllers -o public/doc

可能遇到的问题:
1.json文件配置url不对,导致一直加载中
2.注释格式不正确,导致无法生成文档

http://apidocjs.com/#getting-started(官方文档)
http://www.jianshu.com/p/a799c23234b8

Laravel API Documentation Generator 是一个用于生成 API 文档的工具,它可以基于 Laravel 项目中的路由、控制器和注释来创建文档。自定义生成的 API 文档样式和布局主要可以通过编辑生成器使用的模板文件来实现。以下是自定义样式和布局的一些步骤和建议: 1. **获取模板文件**: 你可以通过克隆 laravel-apidoc-generator 的 GitHub 仓库来获取默认的模板文件。模板文件定义了文档的结构和样式,通常包括 HTML 和 Markdown 文件。 ```bash git clone https://github.com/mpociot/laravel-apidoc-generator.git ``` 2. **修改模板文件**: 在获取模板文件后,你可以根据需要对其进行编辑,比如调整 HTML 结构、CSS 样式或者添加自定义的 JavaScript 脚本。这些模板文件通常位于 `resources/views` 文件夹内。 3. **配置生成器**: 当你安装了 laravel-apidoc-generator 并配置了 API 的路由和注释后,你可以在 `php artisan apidoc:generate` 命令执行时使用 `--template_folder` 选项指定你的自定义模板文件夹路径。 ```bash php artisan apidoc:generate --template_folder={path/to/your/template} ``` 4. **添加自定义样式和脚本**: 在模板文件中,你可以添加自定义的 CSS 链接或者 JavaScript 引用来进一步定制文档的外观和行为。确保这些资源在生成的文档中能够正确加载。 5. **更新依赖**: 如果你修改了模板并添加了新的资源文件,确保这些更改被正确处理,并且在生成文档时不会出现资源未找到的错误。 6. **测试你的更改**: 在自定义了样式和布局之后,运行生成命令并检查文档以确保所有更改都按预期工作。如果有任何问题,需要返回编辑模板文件进行调试。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值