Laravel使用Apidoc注解自动生成Api接口文档

本教程从零开始搭建laravel项目,并安装Apidoc扩展及使用注解生成Api接口文档的教程,该扩展支持 多应用/版本、Markdown文档、在线接口调试、接口生成器、代码模板生成器、Mock调试数据、调试事件、授权访问等非常多的功能,具体可进官网查看。

Laravel 官网 https://laravel.com/docs/8.x/installation

Apidoc 官网 https://docs.apidoc.icu

Apidoc 项目地址 https://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

参考Laravel安装文档

1、根目录下执行安装命令

composer require hg/apidoc

2、生成配置文件

根目录下执行安装命令

php artisan vendor:publish --provider="hg\apidoc\providers\LaravelService"

在这里插入图片描述

2、下载前端文件

点击前端文件下载链接,下载完成后解压;并将其解压到 public目录下

在这里插入图片描述

注解体验

1、修改apps配置

在这里插入图片描述

2、写入测试注解

在这里插入图片描述

3、查看效果

在这里插入图片描述

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 3
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值