工程開發
Backend API avatar

Backend API

使用 Rust 和 Axum 設計並實作強健的 RESTful API 端點,涵蓋路由、HTTP 方法、狀態碼與請求/響應處理,並確保符合儲存庫標準。

簡介

此技能為 coreyja.com 基於 Rust 的程式碼庫提供後端 API 邏輯實作的專業指導。它專為負責構建或維護伺服器端基礎設施的開發人員所設計,特別是使用 Axum Web 框架來定義資源導向端點的場景。該技能確保所有 API 開發均遵循 RESTful 原則,促進一致的命名規範、正確使用 HTTP 方法(GET、POST、PUT、PATCH、DELETE)以及標準化的響應格式。開發人員應在構建新 API 路由、修改現有控制器或配置 Web 框架中間件(如速率限制和錯誤處理)時利用此技能。

  • 使用 Axum 框架實作 RESTful API 路由和端點結構。

  • 配置 HTTP 請求處理,包括輸入驗證、參數解析和路徑設計。

  • 定義和管理用於成功、客戶端錯誤和伺服器端失敗的標準化 HTTP 狀態碼。

  • 設定 API 版本控制策略,以確保項目發展過程中的向後相容性。

  • 透過特徵(traits)和服務與項目特定的日誌記錄、追蹤和資料庫互動模組進行整合。

  • 維護路由定義、控制器邏輯和 API 處理模組中的乾淨程式碼標準。

  • 遵循現有項目模式開發巢狀資源路徑和 RESTful 層次結構。

  • 優先使用 Axum 和 Tower 生態系統提供的型別安全 Rust 抽象。

  • 確保所有與 API 相關的邏輯位於適當的目錄結構中,例如 server/ 或專用的控制器模組。

  • 參照儲存庫文件 (agent-os/standards/backend/api.md) 中定義的後端標準,以保持架構一致性。

  • 驗證所有端點變更皆已涵蓋在迴歸測試中,以確保服務穩定性。

  • 根據等冪性需求(例如 PUT 與 PATCH)應用適當的 HTTP 方法,以維持 REST 合規性。

  • 使用此技能來連結前端請求與後端服務邏輯,確保個人網站 API 層的資料流順暢。

倉庫統計

Star 數
6
Fork 數
1
Open Issue 數
14
主要語言
Rust
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午09:18
在 GitHub 查看