php artisan serve --host 0.0.0.0
php artisan serve --port 8080
地址:
http://127.0.0.1/blogkjh/public/api/documentation
1、安装包
composer require darkaonline/l5-swagger
2、配置
php artisan vendor:publish --provider “L5Swagger\L5SwaggerServiceProvider”
3、启动服务
php artisan serve
刚开始启动会报错,因为还没有写注释文档
注释文档可以这样写
/*** @OA\Info(title="查询api", version="0.1")*//*** @OA\Get(* path="/article",* @OA\Response(response="200", description="An example resource")* )*/
然后命令行输入:
php artisan l5-swagger:generate
生成
关于注释:
@SWG,现在最新版本使用的是 @OA 做为标识
标题添加参数
/*** @OA\Post(* path="/article",* summary="Adds a new user",* @OA\RequestBody(* @OA\MediaType(* mediaType="application/json",* @OA\Schema(* @OA\Property(* property="title",* type="string"* ),* @OA\Property(* property="content",* type="string"* ),* example={"title": "a3fb6", "content": "Jessica Smith"}* )* )* ),* @OA\Response(* response=200,* description="OK"* )* )*/
热更新
全局搜索generate_always
'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false),改为true即可
增加请求体里的内容:
概览
@OA\Parameter(name="userId", in="query", @OA\Schema(type="intger"), required=true, description="用户ID"),
in
in中的内容可以是query也可以是path
单个api介绍:
summary="根据 ID 获取文章信息",
标签分类
tags={"用户管理"},
参考博客:
https://learnku.com/articles/37313