查看Swagger API文档

Question

我正在尝试使用swagger-php和l5-swagger为Laravel 5.7应用程序生成Swagger（OpenAPI）API文档。

这是我的第一次尝试，以下是我按照文档的步骤进行的：

1. 运行命令：composer require zircote/swagger-php

2. 运行命令：composer require darkaonline/l5-swagger

3. 将 L5Swagger\L5SwaggerServiceProvider::class, 添加到 config/app.php 文件中

4. 向 BookController 添加注释

5. 运行命令：php artisan l5-swagger:generate

我的 BookController 如下所示，其中包含注释。

/**
 * @OA\Info(
 *      version="1.0.0",
 *      title="Laravel Test OpenApi",
 *      description="L5 Swagger OpenApi description",
 *      @OA\Contact(
 *          email="[e-mail]"
 *      ),
 *     @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文档呢？我完全不知道要使用哪个URL，希望能得到一些帮助。

- Mena

---

你目前使用哪个库来为 Laravel 8.x 生成文档？ - Matt Silva

Answer 1

问题已解决。正确的URL以加载Swagger UI为http://localhost:8000/api/documentation

希望这可以节省其他人宝贵的开发时间。

- Mena