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

参考Laravel安装文档

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

composer require hg/apidoc

2、生成配置文件

根目录下执行安装命令

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

在这里插入图片描述

2、下载前端文件

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

在这里插入图片描述

注解体验

1、修改apps配置

在这里插入图片描述

2、写入测试注解

在这里插入图片描述

3、查看效果

在这里插入图片描述

本作品采用《CC 协议》,转载必须注明作者和本文链接
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 12

一直搞不懂,这种注释生成的文档的优势在哪里?
根本没减少编写文档的工作量

1周前 评论
hg-code (楼主) 1周前
ykxiao 1周前
hg-code (楼主) 1周前

还不错啦

开发文档这种东西, 建议还是和源代码分离还开。这种 注解 影响感官,有一种臃肿的感觉。其实开发文档 轻量型的框架还是有很多的,开发也很简单。

个人推荐 docsify, 有时间可以了解下。

1周前 评论
hg-code (楼主) 1周前

这样写确实太麻烦了点,像 java 那样还是比较方便

1周前 评论
hg-code (楼主) 1周前

我一般都是用swagger 自动生成注释,再导入到apifox 调试

1周前 评论
hg-code (楼主) 1周前

好用的不得了,从tp开始就在用,没想到出laravel的了,感谢楼主开源

1周前 评论
hg-code (楼主) 1周前

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!