Apidoc接口文档

Apidoc是什么

Apidoc是一个通过解析注解生成Api接口文档的PHP composer扩展，兼容Laravel、ThinkPHP、Hyperf、Webman等框架。

1、 安装扩展

saiadmin本身没有安装这个扩展，如需使用需要单独安装扩展：

composer require hg/apidoc

注：在安装本插件时，确保你已成功安装saiadmin的项目并成功运行。

2、添加前端页面

仓库地址Gitee：https://github.com/HGthecode/apidoc-php

下载地址：https://gitee.com/hg-code/apidoc-php/releases/download/v5.2.1/apidoc-ui.zip

下载完成后对文件进行解压，将apidoc文件拷贝到webman项目的public目录下。目录结构图如下：

├── app
├── public
│   ├── 404.html
│   ├── apidoc
│   │   ├── assets
│   │   ├── config.js
│   │   ├── favicon.ico
│   │   ├── index.html
│   │   ├── monacoeditorwork
│   │   ├── style.css
│   │   └── utils
│   └── favicon.ico

打开浏览器访问 http://127.0.0.1:8787/apidoc/index.html。出现接口文档页面，表示安装成功。

3、配置参数

安装插件后会在webman项目插件配置生成一个config/plugin/hg/apidoc/app.php的配置文件，以下为该文件可配置的参数说明。

<?php
return [
    'enable' => true,
    'apidoc' => [
        // （选配）文档标题，显示在左上角与首页
        'title' => 'saiadmin',
        // （选配）文档描述，显示在首页
        'desc' => 'saiadmin接口文档',
        // （必须）设置文档的应用/版本
        'apps' => [
            [
                // （必须）标题
                'title' => 'CMS接口文档',
                // （必须）控制器目录地址
                'path' => 'app\cms\controller',
                // （必须）唯一的key
                'key' => 'cms',
            ],
            ... 
        ],
       ...   
    ]
];