查看Swagger文档

Question

我试图使用swagger-php和L5-傲慢为Laravel5.7应用程序生成swagger(openapi) api文档

这是我的第一次尝试，下面是我在文档之后所做的工作。

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());
    }
}

现在，我如何查看api文档？我完全不知道网址可以使用，并希望得到一些帮助。

Answer 1

解决了。加载swagger的正确url是http://localhost:8000/api/documentation。

我希望它能为其他人节省一些质量开发时间。