README

简介

允许使用 Swagger-PHP 注解来配置以下框架的路由

要求

PHP 7.2 或更高版本 - 根据框架版本而定。

安装

您可以使用 composer 或直接 下载发行版。

Composer

首选方法是通过 composer。如果您尚未安装 composer，请按照安装说明进行操作。

安装 composer 后，在项目根目录中执行以下命令以安装此库

composer require radebatz/openapi-router

之后，所有必要的类都应在您的项目中可用，以添加路由支持。

基本用法

以下是一个使用 Slim 框架适配器和标准 OpenApi 注解的示例。

index.php

<?php

use Radebatz\OpenApi\Routing\Adapters\SlimRoutingAdapter;
use Radebatz\OpenApi\Routing\OpenApiRouter;
use Slim\App;

require '../vendor/autoload.php';

$app = new App();
(new OpenApiRouter([__DIR__ . '/../src/controllers'], new SlimRoutingAdapter($app)))
    ->registerRoutes();

$app->run();

控制器

<?php

namespace MyApp\Controllers;

class GetController
{

    /**
     * @OA\Get(
     *     path="/getme",
     *     x={
     *       "name": "getme"
     *     },
     *     @OA\Response(response="200", description="All good")
     * )
     */
    public function getme($request, $response) {
        return $response->write('Get me');
    }
}

文档

许可证

openapi-router 项目是在 MIT 许可证下发布的。

radebatz / openapi-router

维护者

详情

README

简介

要求

安装

基本用法

文档

许可证