README

Bone Mvc 框架的 OpenApi 包

安装

使用 Composer

composer require delboy1978uk/open-api

使用方法

只需将以下内容添加到 config/packages.php

<?php

// use statements here
use Bone\OpenApi\OpenApi\OpenApiPackage;

return [
    'packages' => [
        // packages here...,
        OpenApiPackage::class,
    ],
    // ...
];

创建一个配置数组条目/文件。您可以添加一个客户端，以便文档页面可以授权并测试您的端点。

<?php

return [
    'docs' => 'data/docs/api.json',
    'swaggerClient' => [
        'clientId' => '',
        'clientSecret' => '',
    ],
];

运行 booty 以部署前端资源。

vendor/bin/bone assets:deploy

扫描您的 API 注释。

vendor/bin/bone docs:generate

现在您可以去 /api/docs 查看您的 API 文档。😃

delboy1978uk / bone-open-api

维护者

详细信息

README

安装

使用方法