README

自动生成laravel API文档

版本兼容性

文档

安装

composer require caps/laravelapi

添加提供者

编辑app\Providers\AppServiceProvider.php

public function boot()
{
    if ($this->app->environment() !== 'production') {
        $this->app->register(LaravelApiProvider::class);
    }
}

编辑配置文件

您可以将 laravelapi/config/generate_api.php 复制到 config 文件夹中
project_name 定义为自由

用法

用法非常简单
只需在类前定义 @desc
只需在类前定义 @rule/@return/@exception

示例

/**
 * 测试队列使用
 * Class PodcastController
 * @package App\Http\Controllers\API
 */
class PodcastController extends Controller
{
    /**
     * 入队列
     * @decc 入队列
     * @rule string product_id 产品ID required
     * @rule int status 状态 required
     * @rule string company_name 所属企业
     * @rule string category_name 产品类型名称 required
     * @rule string name 产品名称 required
     * @return string product_id 产品ID
     * @return string code 产品编码(系统)
     * @return string status 状态
     * @return string company_name 所属企业
     * @return string category_name 产品类型名称
     * @return string category_code 产品类型编码
     * @return string name 产品名称
     * @return string model 产品编码(企业）
     * @return string bundle_amount 产品装箱规格
     * @return string buyer_company 可见企业
     * @return string remark 产品备注
     * @return \Illuminate\Http\JsonResponse
     */
    public function store()
    {
        return response()->json(['msg' => '队列添加成功']);
    }

    /**
     * 测试
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function test()
    {
        return view('api_list');
    }
}

最后，您可以通过访问 http://{website}/gapi/docs 来预览效果
**祝您玩得开心!!! **

致谢

非常感谢 phalapi，这是API文档灵感的来源 phalapi
phalapi 是一个非常简单且易于使用的PHP框架，它的API文档非常优雅，我想将其移植到laravel框架中

https://www.phalapi.net/