我的编程空间,编程开发者的网络收藏夹
学习永远不晚

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

短信预约 -IT技能 免费直播动态提醒
省份

北京

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团
手机号立即预约

请填写图片验证码后获取短信验证码

看不清楚,换张图片

免费获取短信验证码

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、查看效果

在这里插入图片描述

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

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

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

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

下载Word文档

猜你喜欢

SpringBoot使用swagger生成api接口文档的方法详解

在之前的文章中,使用mybatis-plus生成了对应的包,在此基础上,我们针对项目的api接口,添加swagger配置和注解,生成swagger接口文档,需要的可以了解一下
2022-11-13

编程热搜

  • Python 学习之路 - Python
    一、安装Python34Windows在Python官网(https://www.python.org/downloads/)下载安装包并安装。Python的默认安装路径是:C:\Python34配置环境变量:【右键计算机】--》【属性】-
    Python 学习之路 - Python
  • chatgpt的中文全称是什么
    chatgpt的中文全称是生成型预训练变换模型。ChatGPT是什么ChatGPT是美国人工智能研究实验室OpenAI开发的一种全新聊天机器人模型,它能够通过学习和理解人类的语言来进行对话,还能根据聊天的上下文进行互动,并协助人类完成一系列
    chatgpt的中文全称是什么
  • C/C++中extern函数使用详解
  • C/C++可变参数的使用
    可变参数的使用方法远远不止以下几种,不过在C,C++中使用可变参数时要小心,在使用printf()等函数时传入的参数个数一定不能比前面的格式化字符串中的’%’符号个数少,否则会产生访问越界,运气不好的话还会导致程序崩溃
    C/C++可变参数的使用
  • css样式文件该放在哪里
  • php中数组下标必须是连续的吗
  • Python 3 教程
    Python 3 教程 Python 的 3.0 版本,常被称为 Python 3000,或简称 Py3k。相对于 Python 的早期版本,这是一个较大的升级。为了不带入过多的累赘,Python 3.0 在设计的时候没有考虑向下兼容。 Python
    Python 3 教程
  • Python pip包管理
    一、前言    在Python中, 安装第三方模块是通过 setuptools 这个工具完成的。 Python有两个封装了 setuptools的包管理工具: easy_install  和  pip , 目前官方推荐使用 pip。    
    Python pip包管理
  • ubuntu如何重新编译内核
  • 改善Java代码之慎用java动态编译

目录