我是PHP新手。以前,我曾在NodeJS,Python和Java中工作。我试图在darkaonline / swagger-lume的帮助下将zircote / swagger-php与我的lumen rest api框架集成在一起以生成API文档。我尝试了这两个文档中提到的几乎所有步骤。
我正在使用Laravel框架流明(5.4.7)(Laravel组件5.4。*) 和zricote / swagger-php verison 2.0 和darkaonline / swagger-lume版本“〜3.0”
我尝试了darkaonline / swagger-lume文档中提到的这些步骤,
我在bootstrap / app.php中配置了所有必需的行,然后 使用swagger-lume publish命令发布了所有这些文件。
作曲家也需要zircote / swagger-php
然后我在控制器文件函数中添加了一些示例注释。
然后我再次发表所有文章,然后大张旗鼓地跑:generate 命令。
打开bootstrap / app.php文件,并在“创建应用程序”部分中取消注释此行(第26行附近): $ app-> withFacades();
在“注册容器绑定”部分之前添加以下行:
$app->configure('swagger-lume');
在注册服务提供商部分中添加以下行:
$app->register(\SwaggerLume\ServiceProvider::class);
运行 php artisan swagger-lume:发布配置 发布配置(config / swagger-lume.php) 跑 php artisan swagger-lume:publish
发布所有内容
composer require 'zircote/swagger-php:3.*'
我的示例注释将是这样的:
/** @SWG\Get(
* path="/api/dashboard",
* description="Returns dashboard overview.",
* produces={"application/json"},
* tags={"dashboard"},
* @SWG\Response(
* response=200,
* description="Dashboard overview."
* ),
* @SWG\Response(
* response=401,
* description="Unauthorized action."
* )
* )
**/
php artisan swagger-lume:generate
最后,我打开试图打它,以使其在浏览器中获得文档,如下所示。
尝试的网址路径如下:http://localhost/xyzsapi/public/index.php/docs
它显示了我在控制器文件中提到的json中的注释,而没有任何适当的UI。