广告
返回顶部
首页 > 资讯 > 后端开发 > PHP编程 >Laravel使用Apidoc注解自动生成Api接口文档
  • 881
分享到

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

laravelphpdoc后端api 2023-09-05 14:09:04 881人浏览 薄情痞子
摘要

本教程从零开始搭建laravel项目,并安装apidoc扩展及使用注解生成Api接口文档的教程,该扩展支持 多应用/版本、markdown文档、在线接口调试、接口生成器、代码模板生成器、Mock调试数

教程从零开始搭建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、查看效果

在这里插入图片描述

来源地址:https://blog.csdn.net/qq_25243841/article/details/127851416

--结束END--

本文标题: Laravel使用Apidoc注解自动生成Api接口文档

本文链接: https://www.lsjlt.com/news/395437.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作