README

这是一个基于laravel的自动API接口文档生成工具。

要求

PHP >= 7.0.0
Laravel >= 5.5.0
Fileinfo PHP 扩展

安装

首先

composer require ycpfzf/apidoc

然后运行以下命令来发布资源和配置：

php artisan vendor:publish --provider="Ycpfzf\Apidoc\DocServiceProvider"

配置

config/admin.php 文件包含一组配置，您可以在其中找到默认配置。

 'controller' => [
      
        'App\Http\Controllers\Api\Index'
    ],

使用

给控制器类添加注释，例如

<?php
namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;

/**
 * @title 用户
 * @description 用户信息
 * @group 公共分组
 * @header name:Authorization require:1 default: desc:Token
 *
 */
class Index extends Controller
{

    /**
     * @title 用户信息
     * @description 获取用户的基本信息
     * @author fzf
     * @url /api/user
     * @method get
     * @param name:page type:string require:0 default:1 other: desc:当前页
     * @param name:num type:string require:0 default:10 other: desc:每页记录数
     * @return token:名称
     */
    function index(){
        return [
            'status_code'=>200,
            'message'=>'success',
            'data'=>null,
            'time'=>time(),
        ];
    }
}

打开http://your-url/doc来查看API文档

安全漏洞

如果您发现安全漏洞，请发送电子邮件至ysfzf@hotmail.com。所有安全漏洞都将得到及时处理。

许可协议

APIDOC是开源软件，许可协议为MIT许可协议。

ycpfzf / apidoc

维护者

详细信息

README

要求

安装

配置

使用

安全漏洞

许可协议