diff --git a/app/Http/Middleware/CheckIsEnableApi.php b/app/Http/Middleware/CheckIsEnableApi.php new file mode 100644 index 00000000..31ddb6bc --- /dev/null +++ b/app/Http/Middleware/CheckIsEnableApi.php @@ -0,0 +1,23 @@ +error('管理员未启用 API')->setStatusCode(403); + } + + return $next($request); + } +} diff --git a/resources/views/common/api.blade.php b/resources/views/common/api.blade.php index 4b5abba6..7f5ef0ed 100644 --- a/resources/views/common/api.blade.php +++ b/resources/views/common/api.blade.php @@ -78,8 +78,43 @@ -

超出请求配额后,程序将会返回 HTTP 429 Too Many Requests 错误。文档中接口的请求参数,使用红色「*」符号标注,则表示为必传项。

+ +
+

响应状态码 HTTP Status Code 说明

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ 状态码 + + 说明 +
401未登录或授权失败
403管理员关闭了接口功能
429超出请求配额,请求受限
500服务端出现异常
+
+ +

文档中接口的请求参数,使用红色「*」符号标注,则表示为必传项。

授权相关

diff --git a/routes/api.php b/routes/api.php index c80119d9..31621035 100644 --- a/routes/api.php +++ b/routes/api.php @@ -5,6 +5,7 @@ use App\Http\Controllers\Api\V1\ImageController; use App\Http\Controllers\Api\V1\AlbumController; use App\Http\Controllers\Api\V1\TokenController; use App\Http\Controllers\Api\V1\UserController; +use App\Http\Middleware\CheckIsEnableApi; /* |-------------------------------------------------------------------------- @@ -17,7 +18,10 @@ use App\Http\Controllers\Api\V1\UserController; | */ -Route::group(['prefix' => 'v1'], function () { +Route::group([ + 'prefix' => 'v1', + 'middleware' => CheckIsEnableApi::class, +], function () { Route::post('upload', [ImageController::class, 'upload']); Route::post('tokens', [TokenController::class, 'store'])->middleware('throttle:3,1');