From 5454d1a7b208cc017fd7c6f43d8af215fda096d5 Mon Sep 17 00:00:00 2001
From: beilunyang <786220806@qq.com>
Date: Mon, 10 Feb 2025 11:51:47 +0800
Subject: [PATCH] refactor: Update API documentation and curl examples with
 protocol-aware URLs

---
 README.md                                | 21 +++++++--------------
 app/components/profile/api-key-panel.tsx | 16 ++++++++--------
 2 files changed, 15 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 4bcb93a..178b9fc 100644
--- a/README.md
+++ b/README.md
@@ -411,33 +411,26 @@ Content-Type: application/json
 
 #### 获取邮箱列表
 ```http
-GET /api/emails?cursor=xxx&limit=10
+GET /api/emails?cursor=xxx
 ```
 参数说明：
 - `cursor`: 分页游标，可选
-- `limit`: 每页数量，默认 10
 
-#### 获取单个邮箱
+#### 获取指定邮箱邮件列表
 ```http
-GET /api/emails/{emailId}
+GET /api/emails/{emailId}?cursor=xxx
 ```
+参数说明：
+- `cursor`: 分页游标，可选
 
 #### 删除邮箱
 ```http
 DELETE /api/emails/{emailId}
 ```
 
-#### 获取邮件列表
+#### 获取单封邮件内容
 ```http
-GET /api/emails/{emailId}/messages?cursor=xxx&limit=10
-```
-参数说明：
-- `cursor`: 分页游标，可选
-- `limit`: 每页数量，默认 10
-
-#### 获取单封邮件
-```http
-GET /api/emails/{emailId}/messages/{messageId}
+GET /api/emails/{emailId}/{messageId}
 ```
 
 ### 使用示例
diff --git a/app/components/profile/api-key-panel.tsx b/app/components/profile/api-key-panel.tsx
index 0073e3e..e8a5438 100644
--- a/app/components/profile/api-key-panel.tsx
+++ b/app/components/profile/api-key-panel.tsx
@@ -324,7 +324,7 @@ export function ApiKeyPanel() {
                             variant="ghost"
                             size="icon"
                             onClick={() => copyToClipboard(
-                              `curl -X POST https://${window.location.host}/api/emails/generate \\
+                              `curl -X POST ${window.location.protocol}//${window.location.host}/api/emails/generate \\
   -H "X-API-Key: YOUR_API_KEY" \\
   -H "Content-Type: application/json" \\
   -d '{
@@ -338,7 +338,7 @@ export function ApiKeyPanel() {
                           </Button>
                         </div>
                         <pre className="text-xs bg-muted/50 rounded-lg p-4 overflow-x-auto">
-                          {`curl -X POST https://${window.location.host}/api/emails/generate \\
+                          {`curl -X POST ${window.location.protocol}//${window.location.host}/api/emails/generate \\
   -H "X-API-Key: YOUR_API_KEY" \\
   -H "Content-Type: application/json" \\
   -d '{
@@ -356,7 +356,7 @@ export function ApiKeyPanel() {
                             variant="ghost"
                             size="icon"
                             onClick={() => copyToClipboard(
-                              `curl https://${window.location.host}/api/emails?cursor=CURSOR \\
+                              `curl ${window.location.protocol}//${window.location.host}/api/emails?cursor=CURSOR \\
   -H "X-API-Key: YOUR_API_KEY"`
                             )}
                           >
@@ -364,7 +364,7 @@ export function ApiKeyPanel() {
                           </Button>
                         </div>
                         <pre className="text-xs bg-muted/50 rounded-lg p-4 overflow-x-auto">
-                          {`curl https://${window.location.host}/api/emails?cursor=CURSOR \\
+                          {`curl ${window.location.protocol}//${window.location.host}/api/emails?cursor=CURSOR \\
   -H "X-API-Key: YOUR_API_KEY"`}
                         </pre>
                       </div>
@@ -376,7 +376,7 @@ export function ApiKeyPanel() {
                             variant="ghost"
                             size="icon"
                             onClick={() => copyToClipboard(
-                              `curl https://${window.location.host}/api/emails/{emailId}/messages?cursor=CURSOR \\
+                              `curl ${window.location.protocol}//${window.location.host}/api/emails/{emailId}?cursor=CURSOR \\
   -H "X-API-Key: YOUR_API_KEY"`
                             )}
                           >
@@ -384,7 +384,7 @@ export function ApiKeyPanel() {
                           </Button>
                         </div>
                         <pre className="text-xs bg-muted/50 rounded-lg p-4 overflow-x-auto">
-                          {`curl https://${window.location.host}/api/emails/{emailId}/messages?cursor=CURSOR \\
+                          {`curl ${window.location.protocol}//${window.location.host}/api/emails/{emailId}?cursor=CURSOR \\
   -H "X-API-Key: YOUR_API_KEY"`}
                         </pre>
                       </div>
@@ -396,7 +396,7 @@ export function ApiKeyPanel() {
                             variant="ghost"
                             size="icon"
                             onClick={() => copyToClipboard(
-                              `curl https://${window.location.host}/api/emails/{emailId}/{messageId} \\
+                              `curl ${window.location.protocol}//${window.location.host}/api/emails/{emailId}/{messageId} \\
   -H "X-API-Key: YOUR_API_KEY"`
                             )}
                           >
@@ -404,7 +404,7 @@ export function ApiKeyPanel() {
                           </Button>
                         </div>
                         <pre className="text-xs bg-muted/50 rounded-lg p-4 overflow-x-auto">
-                          {`curl https://${window.location.host}/api/emails/{emailId}/{messageId} \\
+                          {`curl ${window.location.protocol}//${window.location.host}/api/emails/{emailId}/{messageId} \\
   -H "X-API-Key: YOUR_API_KEY"`}
                         </pre>
                       </div>