laravel 5.6集成 swagger3 和swagger-ui 步骤
git地址packagist地址swagger在线edit安装swaggercomposer require zircote/swagger-php然后创建一个 swagger function getJson/*** @SWG\Swagger(*host="qs.com",*consumes={"multipart/form-data"},*...
·
- 安装swagger
composer require zircote/swagger-php
- 然后创建一个 swagger function getJson
/**
* @SWG\Swagger(
* host="qs.com",
* consumes={"multipart/form-data"},
* produces={"application/json"},
* @SWG\Info(
* version="0.0.1",
* title="大黄专用",
* description="趣租乐管理系统接口"
* ),
* @SWG\Tag(
* name="User",
* description="用户操作",
* externalDocs={"description":"基础用户操作接口"}
* ),
*
* @SWG\Tag(
* name="MainPage",
* description="首页模块",
* ),
* )
*/
public function getJSON()
{
//扫描地址
$swagger = \Swagger\scan(app_path('Http/Controllers/'));
return response()->json($swagger, 200);
}
- 路由到getJson 在需要api的function上写注释
/**
* @SWG\Put(path="/swagger/my-data",
* tags={"User"},
* summary="测试get1",
* description="请求该接口需要先登录。",
* operationId="getMyData",
* produces={"application/json"},
* @SWG\Parameter(
* in="body",
* name="body",
* type="integer",
* description="拿数据的理由",
* required=true,
* schema={
* "$ref": "#/definitions/Pet"
* }
* ),
* @SWG\Response(response="200", description="操作成功")
* )
*/
- 如果有 schema 可以在返回值附近再次注释返回格式
/**
* @SWG\Definition(
* definition="Pet",
* @SWG\Property(
* example="1|2",
* property="code",
* type="integer",
* ),
* @SWG\Property(
* property="msg",
* type="string"
* ),
* @SWG\Property(
* property="info",
* type="object",
* example="{num1:1,num2:2}",
* )
* ),
*/
- 配置完json接口 配置 swagger-ui
- 下载好 把dist文件夹内所有内容 拷贝到web根目录
- index.html 修改内容
url 改成 getJson路由
新增 屏蔽右下角error
window.swaggerUi = new SwaggerUi({
validatorUrl: null,
});
end
更多推荐
已为社区贡献1条内容
所有评论(0)