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

thinkphp6使用Apidoc生成接口文档

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

北京

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

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

看不清楚,换张图片

免费获取短信验证码

thinkphp6使用Apidoc生成接口文档

下载-配置-使用

下载Apidoc

进入项目根目录,执行如下命令:

composer require hg/apidoc

添加前端页面
github下载:https://github.com/HGthecode/apidoc-php/releases/download/v5.0.10/apidoc-ui.zip
gitee下载:https://gitee.com/hg-code/apidoc-php/releases/download/v5.0.10/apidoc-ui.zip

下载完成后解压,将apidoc文件夹拷贝到你的项目 public 目录下
打开浏览器访问 http://你的域名/apidoc/ ,出现接口文档页面,表示安装成功。

配置apidoc.php文件

打开与app同级的config文件,找到里面的apidoc.php文件。
在这里插入图片描述
配置里面apps,将里面的path改成你使用项目的path

// (必须)设置文档的应用/版本    'apps'           => [        [            // (必须)标题            'title'=>'Api接口',            // (必须)控制器目录地址            'path'=>'app\shop\controller',            // (必须)唯一的key            'key'=>'api',        ]    ],

在控制器里添加注解

首先需要在控制器中引入:use hg\apidoc\annotation as Apidoc;
在这里插入图片描述

打开文档

在这里插入图片描述
就可以写自己项目的接口文档啦

来源地址:https://blog.csdn.net/xy123boy/article/details/130765003

免责声明:

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

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

thinkphp6使用Apidoc生成接口文档

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

下载Word文档

猜你喜欢

怎么用java快速生成接口文档

本篇内容主要讲解“怎么用java快速生成接口文档”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“怎么用java快速生成接口文档”吧!目录前言方案一,使用japidocs基本用法方案2,swagge
2023-06-20

django怎么自动生成接口文档

Django没有内置的功能来自动生成接口文档,但是可以使用第三方工具来实现自动生成接口文档。以下是一些常用的自动生成接口文档的工具:Django Rest Swagger:这是一个为Django Rest Framework提供Swagg
2023-10-23

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

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

golang组件swagger生成接口文档的方法

这篇文章主要介绍“golang组件swagger生成接口文档的方法”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“golang组件swagger生成接口文档的方法”文章能帮助大家解决问题。swagge
2023-06-30

如何使用eclipse生成java文档

1、Project下的Generate Javadoc选项2、Javadoc command:设置javadoc生成程序,一般来说是JDK目录下bin目录的javadoc.exe。然后选择要生成文档的java项目,然后选择文档输出目录3、下一步4、这一步设置的
如何使用eclipse生成java文档
2018-07-02

java集成开发SpringBoot生成接口文档的方法是什么

这篇文章主要介绍“java集成开发SpringBoot生成接口文档的方法是什么”,在日常操作中,相信很多人在java集成开发SpringBoot生成接口文档的方法是什么问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家
2023-06-25

【Apifox Helper】自动生成接口文档,IDEA+Apifox懒人必备

文章目录 前言🍊缘由接口文档对接爽,整理起来真费脑 ⏲️本文阅读时长约10分钟 🥮前置条件1. IDEA开发工具2. Apifox(不必要) 🎯主要目标一秒生成
2023-08-16

PHP使用Swagger生成好看的API文档

api文档不能根据代码的变化发生实时动态的改变,这样后端修改了接口,前端不能及时获取最新的接口,导致调用出错,需要手动维护api文档,加大了开发的工作量和困难,而swagger的出现就是为了解决这一系列的问题
2023-02-15

编程热搜

  • 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动态编译

目录