v3knet/swagger-module

此包的最新版本(0.2.0)没有提供许可信息。

0.2.0 2015-09-27 22:52 UTC

This package is not auto-updated.

Last update: 2024-09-14 17:58:56 UTC


README

此模块提供(1)位于 /swagger 的 Swagger UI 和(2)自动生成 /swagger.json 文件。

示例

定义 Swagger 注释,模块将将其添加到 swagger.json 响应中。

namespace my_module\controllers;

use vendor_name\project_name\system\controllers\BaseController;
use vendor_name\project_name\swagger\annotations as Swagger;

class HelloController extends BaseController {

    /**
     * @Swagger\Param(name="name", in="path")
     * @Swagger\Response("Hello")
     */
    public function actionGet($name) {
        return $this->json(new Hello($name));
    }

}