Engineering
Backend API avatar

Backend API

Design and implement robust RESTful API endpoints in Rust using Axum, managing routes, HTTP methods, status codes, and request/response handling consistent with repository standards.

Introduction

This skill provides specialized guidance for implementing backend API logic within the coreyja.com Rust-based codebase. It is designed for developers tasked with building or maintaining server-side infrastructure, specifically utilizing the Axum web framework to define resource-based endpoints. The skill ensures that all API development adheres to RESTful principles, promoting consistent naming conventions, proper utilization of HTTP methods (GET, POST, PUT, PATCH, DELETE), and standardized response formatting. Developers should leverage this skill when constructing new API routes, modifying existing controllers, or configuring web framework middleware such as rate limiting and error handling.

  • Implementation of RESTful API routes and endpoint structures using the Axum framework.

  • Configuration of HTTP request handling, including input validation, parameter parsing, and path design.

  • Definition and management of standardized HTTP status codes for success, client errors, and server-side failures.

  • Setup of API versioning strategies to ensure backward compatibility as the project evolves.

  • Integration with project-specific modules for logging, tracing, and database interactions through traits and services.

  • Maintenance of clean code standards in route definitions, controller logic, and API handler modules.

  • Development of nested resource paths and RESTful hierarchies following existing project patterns.

  • Prioritize the use of type-safe Rust abstractions provided by the Axum and Tower ecosystems.

  • Ensure all API-related logic resides within appropriate directory structures like server/ or dedicated controller modules.

  • Utilize the defined backend standards referenced in the repository’s documentation (agent-os/standards/backend/api.md) for architectural consistency.

  • Validate that all endpoint changes are covered by regression tests to ensure service stability.

  • Apply appropriate HTTP methods according to idempotency requirements (e.g., PUT vs. PATCH) to maintain REST compliance.

  • Use this skill to bridge the gap between frontend requests and backend service logic, ensuring seamless data flow across the personal site's API layer.

Repository Stats

Stars
6
Forks
1
Open Issues
14
Language
Rust
Default Branch
main
Sync Status
Idle
Last Synced
May 3, 2026, 09:18 PM
View on GitHub