Laravel使用Apidoc注解自动生成Api接口文档
本教程从零开始搭建laravel项目,并安装Apidoc扩展及使用注解生成Api接口文档的教程,该扩展支持 多应用/版本、Markdown文档、在线接口调试、接口生成器、代码模板生成器、Mock调试数据、调试事件、授权访问等非常多的功能,具体可进官网查看。
Laravel 官网 learnku.com/docs/laravel/8.x/insta...
Apidoc 官网 docs.apidoc.icu
Apidoc 项目地址 github.com/HGthecode/apidoc-php
安装Laravel项目:
使用命令行执行下面的命令
composer create-project laravel/laravel laravel8
部署网站
本教程使用本机的 phpStudy 来部署网站
1、创建一个网站
2、配置伪静态
location / {
try_files $uri $uri/ /index.php?$query_string;
}
3、部署完成
浏览器访问上面配置的域名,出现如下页面表示部署成功
安装Apidoc
1、根目录下执行安装命令
composer require hg/apidoc
2、生成配置文件
根目录下执行安装命令
php artisan vendor:publish --provider="hg\apidoc\providers\LaravelService"
2、下载前端文件
点击前端文件下载链接,下载完成后解压;并将其解压到 public
目录下
注解体验
1、修改apps配置
2、写入测试注解
3、查看效果
本作品采用《CC 协议》,转载必须注明作者和本文链接
推荐文章: