下载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;
在这里插入图片描述

打开文档

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

Logo

瓜分20万奖金 获得内推名额 丰厚实物奖励 易参与易上手

更多推荐