我开始学习招摇了。
我正在尝试做一本书“Hands-On Full Stack Web Development with Angular 6 and Laravel 5”中所做的事情。
输入命令“
php artisan l5-swagger:generate
”后使用 php-fpm bash
我在 VS Code 终端中遇到此异常:
root@8e6435be9103:/application# php artisan l5-swagger:generate
Regenerating docs
ErrorException : Required @OA\Info() not found
at /application/vendor/zircote/swagger-php/src/Logger.php:39
35| $this->log = function ($entry, $type) {
36| if ($entry instanceof Exception) {
37| $entry = $entry->getMessage();
> 39| trigger_error($entry, $type);
40| };
41| }
42|
43| /**
Exception trace:
1 trigger_error("Required @OA\Info() not found")
/application/vendor/zircote/swagger-php/src/Logger.php:39
2 OpenApi\Logger::OpenApi\{closure}("Required @OA\Info() not found")
/application/vendor/zircote/swagger-php/src/Logger.php:71
当我尝试打开 http://localhost:8081/api/documentation url 时,它给出了此错误:
Failed to load API definition.
Fetch errorNot Found http://localhost:8081/docs/api-docs.json
我在 docker 中使用 php-fpm bash。 我的操作系统是 Ubuntu 18.04.3 LTS。
谁能帮我解决这个问题。 谢谢!!!
在运行之前,您必须在代码中添加一些注释
php artisan l5-swagger:generate
。首先,转到 app/Http/Controllers/Controller.php
并在类声明之前添加如下 phpdoc 注释块:
/**
* @OA\Info(title="My First API", version="0.1")
*/
此注释本身足以解决您所描述的问题,但如果您再次执行
php artisan l5-swagger:generate
,您将看到以下异常:
ErrorException : Required @OA\PathItem() not found
at /home/nathanael/dev/laravel-projects/laravel-swagger/vendor/zircote/swagger-php/src/Logger.php:39
35| $this->log = function ($entry, $type) {
36| if ($entry instanceof Exception) {
37| $entry = $entry->getMessage();
38| }
> 39| trigger_error($entry, $type);
40| };
41| }
42|
43| /**
Exception trace:
1 trigger_error("Required @OA\PathItem() not found")
/home/nathanael/dev/laravel-projects/laravel-swagger/vendor/zircote/swagger-php/src/Logger.php:39
2 OpenApi\Logger::OpenApi\{closure}("Required @OA\PathItem() not found")
/home/nathanael/dev/laravel-projects/laravel-swagger/vendor/zircote/swagger-php/src/Logger.php:71
Please use the argument -v to see more details.
那是因为控制器中必须至少有一个带有描述路由的注释的方法。 您可以轻松地在应用程序中创建资源来测试运行
php artisan make:controller ProjectsController -r
并将 Route::resource('projects', 'ProjectsController')
添加到 routes/web.php
。
创建控制器后打开它并在index方法之前添加以下phpdoc注释块,例如:
/**
* @OA\Get(
* path="/projects",
* @OA\Response(response="200", description="Display a listing of projects.")
* )
*/
然后,再次运行
php artisan l5-swagger:generate
,您必须在终端中看到成功消息。
您可以使用此包在 Laravel 中完全自动生成 swagger,而无需在代码中编写任何注释
https://github.com/hussein4alaa/laravel-g4t-swagger-auto-generate
您应该在基本控制器的顶部执行此操作并再次运行命令 1-
/**
@OA\Info(
version="1.0",
title="your title",
description="your description",
)
}
2-php artisan l5-swagger:生成