Skip to content

N
newShopBack
Commit cd6bf123 authored by 郭勇志's avatar 郭勇志
Browse files
Options

swagger路径

parent 0cf244c5
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 451 additions and 70 deletions
backend/config/main.php
View file @ cd6bf123
......@@ -64,6 +64,13 @@ return [
'password' => '',
'charset' => 'utf8',
],
'redis' => [
'class' => 'yii\redis\Connection',
'hostname' => 'r-m5ed79b6945c5a14.redis.rds.aliyuncs.com',
'port' => 6379,
'database' => 3,
'password' => 'r-m5ed79b6945c5a14:KYFe9KQFF7MgYn7y',
],
],
'params' => $params,
];
backend/controllers/v1/BaseController.php
View file @ cd6bf123
......@@ -8,6 +8,7 @@ use yii\filters\auth\CompositeAuth;
use yii\filters\auth\HttpBearerAuth;
use yii\filters\auth\QueryParamAuth;
use yii\filters\Cors;
use backend\components\v1\authorizationFilter;
/**
* Base controller
* 基类
......@@ -16,12 +17,11 @@ use yii\filters\Cors;
* @OA\Info(
* title="后台接口v1版",
* version="v1",
* @OA\Contact(
*
* )
* )
*/
/**
* ),
* @OA\Server(
* description="Api server",
* url="/guoyongzhi",
* ),
* @OA\SecurityScheme(
* securityScheme="Authorization",
* type="apiKey",
......@@ -51,15 +51,16 @@ class BaseController extends ActiveController
],$behaviors);
// 格式化输出请求
$behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
// 配置认证方式（两种都行）
// 认证
$behaviors['HttpBearerAuth']=[
'class' => HttpBearerAuth::className(),
'optional' => ['login'],
];
// $behaviors['QueryParamAuth']=[
// 'class' => QueryParamAuth::className(),
// 'optional' => ['login']
// ];
// 授权
$behaviors['authorizationFilter']=[
'class' => authorizationFilter::className(),
'optional' => [],//过滤不需要验证的action
];
return $behaviors;
}
}
backend/controllers/v1/shop/branch/BranchController.php
View file @ cd6bf123
......@@ -14,7 +14,7 @@ class BranchController extends BaseController
];
/**
* @OA\Get(
* path="/guoyongzhi/weiShopNew/backend/web/v1/shop/branch/branches/test",
* path="/weiShopNew/backend/web/v1/shop/branch/branches/test",
* tags={"swagger事例"},
* description="swagger事例",
* summary="swagger事例",
......@@ -40,6 +40,14 @@ class BranchController extends BaseController
public function actionTest()
{
$get=Yii::$app->request->get();
// $key = 'username';
// $redis = Yii::$app->redis;
// if ($val = $redis->get($key)) {
// Yii::trace('redis',$val );
// } else {
// $redis->set($key, 'test');
// // $redis->expire($key, 5);
// }
return $get;
}
......
backend/controllers/v1/user/UserController.php
View file @ cd6bf123
......@@ -14,7 +14,7 @@ class UserController extends BaseController
];
/**
* @OA\Post(
* path="/guoyongzhi/weiShopNew/backend/web/v1/user/users/login",
* path="/weiShopNew/backend/web/v1/user/users/login",
* tags={"用户&员工接口"},
* summary="后台登陆接口",
* description="后台登陆接口",
......
backend/models/v1/user/LoginForm.php
View file @ cd6bf123
<?php
namespace backend\models\v1\user;
namespace app\models\v1\user;
use Yii;
use yii\base\Model;
......
backend/web/swagger-yaml/v1/swagger.yaml
View file @ cd6bf123
{"openapi":"3.0.0","info":{"title":"\u540e\u53f0\u63a5\u53e3v1\u7248","contact":{},"version":"v1"},"paths":{"\/guoyongzhi\/weiShopNew\/backend\/web\/v1\/shop\/branch\/branches\/test":{"get":{"tags":["swagger\u4e8b\u4f8b"],"summary":"swagger\u4e8b\u4f8b","description":"swagger\u4e8b\u4f8b","operationId":"returnGetParam","parameters":[{"name":"param","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK\u3002\u4e00\u5207\u6b63\u5e38"},"201":{"description":"\u54cd\u5e94 POST \u8bf7\u6c42\u65f6\u6210\u529f\u521b\u5efa\u4e00\u4e2a\u8d44\u6e90"},"204":{"description":"\u8be5\u8bf7\u6c42\u88ab\u6210\u529f\u5904\u7406\uff0c\u54cd\u5e94\u4e0d\u5305\u542b\u6b63\u6587\u5185\u5bb9 (\u7c7b\u4f3c DELETE \u8bf7\u6c42)"},"304":{"description":"\u8d44\u6e90\u6ca1\u6709\u88ab\u4fee\u6539\u3002\u53ef\u4ee5\u4f7f\u7528\u7f13\u5b58\u7684\u7248\u672c"},"400":{"description":"\u9519\u8bef\u7684\u8bf7\u6c42\u3002\u53ef\u80fd\u901a\u8fc7\u7528\u6237\u65b9\u9762\u7684\u591a\u79cd\u539f\u56e0\u5f15\u8d77\u7684\uff0c\u4f8b\u5982\u5728\u8bf7\u6c42\u4f53\u5185\u6709\u65e0\u6548\u7684JSON \u6570\u636e\uff0c\u65e0\u6548\u7684\u64cd\u4f5c\u53c2\u6570\uff0c\u7b49\u7b49"},"401":{"description":"\u9a8c\u8bc1\u5931\u8d25"},"403":{"description":"\u5df2\u7ecf\u7ecf\u8fc7\u8eab\u4efd\u9a8c\u8bc1\u7684\u7528\u6237\u4e0d\u5141\u8bb8\u8bbf\u95ee\u6307\u5b9a\u7684 API \u672b\u7aef"},"404":{"description":"\u6240\u8bf7\u6c42\u7684\u8d44\u6e90\u4e0d\u5b58\u5728\u3002"},"405":{"description":"\u4e0d\u88ab\u5141\u8bb8\u7684\u65b9\u6cd5\u3002 \u8bf7\u68c0\u67e5 Allow header \u5141\u8bb8\u7684HTTP\u65b9\u6cd5"},"415":{"description":"\u4e0d\u652f\u6301\u7684\u5a92\u4f53\u7c7b\u578b\u3002 \u6240\u8bf7\u6c42\u7684\u5185\u5bb9\u7c7b\u578b\u6216\u7248\u672c\u53f7\u662f\u65e0\u6548\u7684"},"422":{"description":"\u6570\u636e\u9a8c\u8bc1\u5931\u8d25 (\u4f8b\u5982\uff0c\u54cd\u5e94\u4e00\u4e2a POST \u8bf7\u6c42)\u3002 \u8bf7\u68c0\u67e5\u54cd\u5e94\u4f53\u5185\u8be6\u7ec6\u7684\u9519\u8bef\u6d88\u606f"},"429":{"description":"\u8bf7\u6c42\u8fc7\u591a\u3002 \u7531\u4e8e\u9650\u901f\u8bf7\u6c42\u88ab\u62d2\u7edd"},"500":{"description":"\u5185\u90e8\u670d\u52a1\u5668\u9519\u8bef\u3002 \u8fd9\u53ef\u80fd\u662f\u7531\u4e8e\u5185\u90e8\u7a0b\u5e8f\u9519\u8bef\u5f15\u8d77\u7684"}},"security":[{"Authorization":[]}]}},"\/guoyongzhi\/weiShopNew\/backend\/web\/v1\/user\/users\/login":{"post":{"tags":["\u7528\u6237&\u5458\u5de5\u63a5\u53e3"],"summary":"\u540e\u53f0\u767b\u9646\u63a5\u53e3","description":"\u540e\u53f0\u767b\u9646\u63a5\u53e3","operationId":"backend\\controllers\\v1\\user\\UserController::actionLogin","requestBody":{"content":{"application\/json":{"schema":{"properties":{"CODE":{"type":"string"},"PASSWORD":{"type":"string"}},"type":"object","example":{"CODE":1234567890,"PASSWORD":"123"}}}}},"responses":{"200":{"description":"\u6210\u529f\u65f6\u8fd4\u56deaccess-token"}}}}},"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"}}}}
\ No newline at end of file
{"openapi":"3.0.0","info":{"title":"\u540e\u53f0\u63a5\u53e3v1\u7248","version":"v1"},"servers":[{"url":"\/guoyongzhi","description":"Api server"}],"paths":{"\/weiShopNew\/backend\/web\/v1\/shop\/branch\/branches\/test":{"get":{"tags":["swagger\u4e8b\u4f8b"],"summary":"swagger\u4e8b\u4f8b","description":"swagger\u4e8b\u4f8b","operationId":"returnGetParam","parameters":[{"name":"param","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK\u3002\u4e00\u5207\u6b63\u5e38"},"201":{"description":"\u54cd\u5e94 POST \u8bf7\u6c42\u65f6\u6210\u529f\u521b\u5efa\u4e00\u4e2a\u8d44\u6e90"},"204":{"description":"\u8be5\u8bf7\u6c42\u88ab\u6210\u529f\u5904\u7406\uff0c\u54cd\u5e94\u4e0d\u5305\u542b\u6b63\u6587\u5185\u5bb9 (\u7c7b\u4f3c DELETE \u8bf7\u6c42)"},"304":{"description":"\u8d44\u6e90\u6ca1\u6709\u88ab\u4fee\u6539\u3002\u53ef\u4ee5\u4f7f\u7528\u7f13\u5b58\u7684\u7248\u672c"},"400":{"description":"\u9519\u8bef\u7684\u8bf7\u6c42\u3002\u53ef\u80fd\u901a\u8fc7\u7528\u6237\u65b9\u9762\u7684\u591a\u79cd\u539f\u56e0\u5f15\u8d77\u7684\uff0c\u4f8b\u5982\u5728\u8bf7\u6c42\u4f53\u5185\u6709\u65e0\u6548\u7684JSON \u6570\u636e\uff0c\u65e0\u6548\u7684\u64cd\u4f5c\u53c2\u6570\uff0c\u7b49\u7b49"},"401":{"description":"\u9a8c\u8bc1\u5931\u8d25"},"403":{"description":"\u5df2\u7ecf\u7ecf\u8fc7\u8eab\u4efd\u9a8c\u8bc1\u7684\u7528\u6237\u4e0d\u5141\u8bb8\u8bbf\u95ee\u6307\u5b9a\u7684 API \u672b\u7aef"},"404":{"description":"\u6240\u8bf7\u6c42\u7684\u8d44\u6e90\u4e0d\u5b58\u5728\u3002"},"405":{"description":"\u4e0d\u88ab\u5141\u8bb8\u7684\u65b9\u6cd5\u3002 \u8bf7\u68c0\u67e5 Allow header \u5141\u8bb8\u7684HTTP\u65b9\u6cd5"},"415":{"description":"\u4e0d\u652f\u6301\u7684\u5a92\u4f53\u7c7b\u578b\u3002 \u6240\u8bf7\u6c42\u7684\u5185\u5bb9\u7c7b\u578b\u6216\u7248\u672c\u53f7\u662f\u65e0\u6548\u7684"},"422":{"description":"\u6570\u636e\u9a8c\u8bc1\u5931\u8d25 (\u4f8b\u5982\uff0c\u54cd\u5e94\u4e00\u4e2a POST \u8bf7\u6c42)\u3002 \u8bf7\u68c0\u67e5\u54cd\u5e94\u4f53\u5185\u8be6\u7ec6\u7684\u9519\u8bef\u6d88\u606f"},"429":{"description":"\u8bf7\u6c42\u8fc7\u591a\u3002 \u7531\u4e8e\u9650\u901f\u8bf7\u6c42\u88ab\u62d2\u7edd"},"500":{"description":"\u5185\u90e8\u670d\u52a1\u5668\u9519\u8bef\u3002 \u8fd9\u53ef\u80fd\u662f\u7531\u4e8e\u5185\u90e8\u7a0b\u5e8f\u9519\u8bef\u5f15\u8d77\u7684"}},"security":[{"Authorization":[]}]}},"\/weiShopNew\/backend\/web\/v1\/user\/users\/login":{"post":{"tags":["\u7528\u6237&\u5458\u5de5\u63a5\u53e3"],"summary":"\u540e\u53f0\u767b\u9646\u63a5\u53e3","description":"\u540e\u53f0\u767b\u9646\u63a5\u53e3","operationId":"backend\\controllers\\v1\\user\\UserController::actionLogin","requestBody":{"content":{"application\/json":{"schema":{"properties":{"CODE":{"type":"string"},"PASSWORD":{"type":"string"}},"type":"object","example":{"CODE":1234567890,"PASSWORD":"123"}}}}},"responses":{"200":{"description":"\u6210\u529f\u65f6\u8fd4\u56deaccess-token"}}}}},"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"}}}}
\ No newline at end of file
composer.lock
View file @ cd6bf123
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment