From b6429aa7cf6f93c488313747bf1884d54adfe1ce Mon Sep 17 00:00:00 2001
From: Wisp X <wisp-x@qq.com>
Date: Sun, 20 Feb 2022 14:27:23 +0800
Subject: [PATCH] =?UTF-8?q?:sparkles:=20=E6=8E=A5=E5=8F=A3=E8=AF=B7?=
 =?UTF-8?q?=E6=B1=82=E9=99=90=E6=B5=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 app/Exceptions/Handler.php           |  5 +++++
 resources/views/common/api.blade.php | 32 ++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)

diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php
index de731466..034fe84f 100644
--- a/app/Exceptions/Handler.php
+++ b/app/Exceptions/Handler.php
@@ -5,6 +5,7 @@ namespace App\Exceptions;
 use App\Http\Api;
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Illuminate\Http\Exceptions\ThrottleRequestsException;
 use Throwable;
 
 class Handler extends ExceptionHandler
@@ -41,6 +42,10 @@ class Handler extends ExceptionHandler
         $this->reportable(function (Throwable $e) {
             //
         });
+
+        $this->renderable(function (ThrottleRequestsException $e) {
+            return $this->error($e->getMessage())->setStatusCode(429);
+        });
     }
 
     protected function unauthenticated($request, AuthenticationException $exception)
diff --git a/resources/views/common/api.blade.php b/resources/views/common/api.blade.php
index bc40bb31..f7df8533 100644
--- a/resources/views/common/api.blade.php
+++ b/resources/views/common/api.blade.php
@@ -18,6 +18,38 @@
                     <p class="text-sm">如果未设置 Authorization 的情况下请求上传接口，将被视为游客上传。</p>
                 </div>
             </div>
+
+            <div class="my-4 overflow-x-auto">
+                <p class="text-sm mb-2">公共响应 headers 说明</p>
+                <table class="min-w-full">
+                    <thead class="bg-gray-50 border">
+                    <tr>
+                        <th scope="col" class="px-3 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider whitespace-nowrap">
+                            字段
+                        </th>
+                        <th scope="col" class="px-3 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider whitespace-nowrap">
+                            类型
+                        </th>
+                        <th scope="col" class="px-3 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider whitespace-nowrap">
+                            说明
+                        </th>
+                    </tr>
+                    </thead>
+                    <tbody class="bg-white border divide-y text-sm">
+                    <tr>
+                        <td class="px-3 py-2 whitespace-nowrap">X-RateLimit-Limit</td>
+                        <td class="px-3 py-2 whitespace-nowrap">Integer</td>
+                        <td class="px-3 py-2 whitespace-nowrap">当前客户端一分钟内请求配额</td>
+                    </tr>
+                    <tr>
+                        <td class="px-3 py-2 whitespace-nowrap">X-RateLimit-Remaining</td>
+                        <td class="px-3 py-2 whitespace-nowrap">Integer</td>
+                        <td class="px-3 py-2 whitespace-nowrap">当前客户端剩余请求配额</td>
+                    </tr>
+                    </tbody>
+                </table>
+                <p class="text-sm my-2 text-red-500">超出请求配额后，程序将会返回 HTTP 429 Too Many Requests 错误。</p>
+            </div>
         </div>
 
         <p class="text-xl mb-2 text-gray-800 font-semibold">图片相关</p>