时间戳

首页 > 解决方案 > 查看 Swagger API 文档

php - 查看 Swagger API 文档

问题描述

我正在尝试使用swagger-php和l5-swagger为 laravel 5.7 应用程序生成 swagger(openapi) api 文档

这是我的第一次尝试，这是我按照文档进行的操作

  1. 作曲家需要 zircote/swagger-php

  2. 作曲家需要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="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 文档？我完全不知道要使用的网址，希望能得到一些帮助。

标签： phplaravelswaggerswagger-uilaravel-5.7

解决方案

解决。加载招摇 UI 的正确 url 是http://localhost:8000/api/documentation

我希望它可以为其他人节省一些高质量的开发时间。

推荐阅读