我正在尝试使用 swagger-php 为 laravel 5.7 应用程序生成 swagger(openapi) api 文档和 l5-swagger
这是我的第一次尝试,下面是我按照文档进行的尝试
Composer 需要 zircote/swagger-php
Composer 需要 darkaonline/l5-swagger
添加
L5Swagger\L5SwaggerServiceProvider::class,
到 config/app.php 文件为 BookController 添加了注解
运行命令
php artisan l5-swagger:generate
我的 BookController 看起来像这样带有注释
/**
* @OA\Info(
* version="1.0.0",
* title="Laravel Test OpenApi",
* description="L5 Swagger OpenApi description",
* @OA\Contact(
* email="menadio1@gmail.com"
* ),
* @OA\License(
* name="Apache 2.0",
* url="http://www.apache.org/licenses/LICENSE-2.0.html"
* )
* )
*/
/**
* @OA\Server(
* url=L5_SWAGGER_CONST_HOST,
* description="L5 Swagger OpenApi dynamic host server"
* )
*
* @OA\Server(
* url="https://projects.dev/api/v1",
* description="L5 Swagger OpenApi Server"
* )
*/
class BookController extends Controller
{
/**
* @OA\Get(
* path="/books",
* operationId="getBooksList",
* tags={"Books"},
* summary="Get list of books",
* description="Returns list of books",
* @OA\Response(
* response=200,
* description="successful operation"
* ),
* @OA\Response(response=400, description="Bad request"),
* )
*
* Returns list of books
*/
public function index()
{
return BookResource::collection(Book::all());
}
}
现在如何查看 api 文档?我完全不知道要使用的网址,希望得到一些帮助。
最佳答案
已解决。加载 swagger UI 的正确 url 是 http://localhost:8000/api/documentation
我希望它能为其他人节省一些高质量的开发时间。
关于php - 查看 Swagger API 文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/56469997/