配置Swagger路由

Question

我希望使用swagger来记录一个laravel，并让用户使用与petstore.swagger.io类似的路径查看应用程序。

以下是我使用swagger-php & l5-swagger包所采取的步骤

1. 作曲家需要锆石/swagger-php
2. 作曲家需要黑暗在线/L5-傲慢
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());
    }
}

此时，我不知道在加载swagger以查看API文档时使用什么url。这是唯一在编码挑战中阻碍我的事情，所以我有点渴望得到帮助。

Answer 1

我能够加载swagger用户界面并使用http://localhost:8000/api/documentation查看api文档

我希望这将节省其他人充分的时间，当第一次使用昂首阔步。

Answer 2

转到项目的根目录并运行以下命令来生成文档。

php artisan l5-swagger:generate   

然后导航到http://yourapp.local/api/docs以查看您的傲慢用户界面