[laravel]laravel8自动生成api文档

最近发现一个问题,使用showdoc无法使用在laravel框架上,所以就要找一个新的方式
之前使用的laravel-apidoc的库也有一年多没更新了,无法使用在laravel8上面
所以我们就使用showdoc也支持的swagger进行处理

技术选型swagger

安装swagger到laravel中

composer require "darkaonline/l5-swagger" //目前是最新的
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

生成文档

php artisan l5-swagger:generate

注释的语法

语法

官方文档OpenAPI Specification:https://swagger.io/specification/

Swagger-PHP v3.xhttps://zircote.github.io/swagger-php/

@OA\Info

一个项目中只能放着一个.

/**
 * @OA\Info(
 *     title="Auth api",
 *     version="0.0.1"
 * )
 */

@OA\Get

还差这个地方的说明

/**
 * @OA\Get(
 *     path="/projects",
 *     @OA\Response(response="200", description="Display a listing of projects.")
 * )
 */