README

composer require avtehnik/service-doc

用法

将注释添加到您的 php 文件中。

/**
 * @ServiceDoc\Info(title="My First API", version="0.1")
 */

/**
 * @ServiceDoc\PathItem(
 *     microservice="payment",
 *     path="/wallet-prices",
 *     method="get",
 *     @ServiceDoc\Tag(
 *          name="user",
 *     )
 * )
 * @param $destination_code
 * @param $source_code
 *
 * @return
 */

从 Yii 使用

将 servicedoc 部分添加到 actions 数组

    class DocumentationController extends Controller
    {
        public function actions()
        {
            return [
                'servicedoc' => [
                    'class' => 'ServiceDoc\YiiServiceDocAction',
                    'scanDir' => [
                        Yii::getAlias('@common/components')
                    ],
                ],
            ];
        }
    }

然后您可以通过 URL /documentation/servicedoc 访问文档

从 php 使用

生成始终是最新的文档。

<?php
require("vendor/autoload.php");
$swagger = \ServiceDoc\scan(__DIR__);
header('Content-type: application/json; charset=utf-8');
echo $swagger->toJson();

avtehnik / service-doc

维护者

详细信息

README

用法

从 Yii 使用

从 php 使用