المهارات rest-patterns
🔗

rest-patterns

آمن

應用 REST API 設計模式

متاح أيضًا من: 0xDarkMatter

正確設計 RESTful API 需要了解 HTTP 方法、狀態碼、快取策略和速率限制。此技能提供快速參考模式,讓您從一開始就能建立符合標準的 API。

يدعم: Claude Codex Code(CC)
⚠️ 68 ضعيف
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "rest-patterns". What status code should I return when a user creates a new resource successfully?

النتيجة المتوقعة:

  • - **201 Created** - 成功建立資源的標準回應
  • - 在 `Location` 標頭中包含新資源的 URL
  • - 在回應主體中返回建立的資源
  • - 範例:`201 Created`,搭配 `Location: /users/123`

التدقيق الأمني

آمن
v3 • 1/10/2026

Pure documentation skill containing only markdown reference material about REST API patterns. No code execution, network calls, file system access beyond its own files, or command execution capabilities.

5
الملفات التي تم فحصها
955
الأسطر التي تم تحليلها
0
النتائج
3
إجمالي عمليات التدقيق
لا توجد مشكلات أمنية
تم تدقيقه بواسطة: claude عرض سجل التدقيق →

درجة الجودة

45
الهندسة المعمارية
100
قابلية الصيانة
83
المحتوى
22
المجتمع
100
الأمان
70
الامتثال للمواصفات

ماذا يمكنك بناءه

設計新的 API 端點

在設計新的 REST 端點時,選擇正確的 HTTP 方法、狀態碼和回應格式。

實作 API 快取

設定 Cache-Control 標頭、ETag 和條件式請求來優化 API 效能。

審查 API 設計

稽核現有 API 的錯誤處理、速率限制和 REST 規範符合度。

جرّب هذه الموجهات

基本狀態碼
What status code should I return when a user creates a new resource successfully?
快取策略
How do I configure caching for user-specific data that should never be stored in shared caches?
速率限制
What headers should I include in responses to inform clients about their rate limits?
錯誤處理
Show me the RFC 7807 format for error responses and give examples for validation errors.

أفضل الممارسات

  • 使用正確的 HTTP 方法:GET 用於讀取、POST 用於建立、PUT 用於完整替換、PATCH 用於部分更新、DELETE 用於刪除。
  • 對於成功的 POST 請求,返回 201 並附帶 Location 標頭,讓用戶端知道新資源的位置。
  • 對於不回傳資料的成功操作使用 204 No Content,並適當區分 400 和 422 表示語法錯誤與驗證錯誤。
  • 為敏感資料設定 Cache-Control 為 no-store,並在更新時使���搭配 If-Match 的 ETag 來實現樂觀鎖定。

تجنب

  • 在 URL 中使用動詞,如 /getUsers,而非使用 /users 搭配 GET 方法。
  • 對所有回應(包括錯誤)都返回 200 OK,而非使用適當的 4xx/5xx 狀態碼。
  • 對授權失敗返回 404(應使用 403),或對認證失敗返回 403(應使用 401 表示未認證,403 表示未授權)。
  • 在集合端點上未實作分頁,可能導致大型資料集出現效能問題。

الأسئلة المتكررة

哪些工具支援此技能?
此技能適用於 Claude、Codex 和 Claude Code。觸發短語包括:REST API、HTTP methods、status codes 和 API design。
主要的 HTTP 方法有哪些?
GET 用於擷取資料、POST 用於建立資源、PUT 用於完整替換、PATCH 用於部分更新、DELETE 用於刪除資源。
如何處理分頁?
使用查詢參數,如 ?page=2&limit=20。在回應的中繼資料中返回總數和總頁數。
使用此技能時我的資料安全嗎?
是的。此技能僅包含文件和參考資料,不會存取檔案、網路或執行程式碼。
為什麼我的 API 很慢?
檢查快取標頭。對條件式請求使用 ETag,並為不同資源類型使用適當 max-age 值的 Cache-Control。
這與 Swagger 有何不同?
此技能提供快速參考模式。Swagger/OpenAPI 會根據 API 定義產生實際的文件和用戶端函式庫。

تفاصيل المطور

المؤلف

0xDarkMatter

الترخيص

MIT

مرجع

main

بنية الملفات