api-route-design

What problem does it solve?

This Skill helps developers design consistent, well-structured RESTful API endpoints in FastAPI or Python projects, ensuring correct validation, serialization, and HTTP semantics.

Core Features & Use Cases

• Endpoint patterns: Implement common REST patterns like GET, POST, PUT, PATCH, and DELETE with clear path naming and proper status codes.
• Validation & Schemas: Use Pydantic models to validate requests and define response schemas for OpenAPI documentation.
• HTTP Semantics: Enforce correct use of HTTP methods, status codes, and error handling (e.g., 200, 201, 204, 404, 422).
• Pagination, Filtering, Sorting: Provide standardized patterns for listing resources with skip/limit, filters, and sort orders.
• Use Case: Design endpoints for a resource like /v1/users with CRUD operations and documented contracts.

Quick Start

Design a new REST resource at /v1/items with GET and POST endpoints using FastAPI, Pydantic models for input and output, and OpenAPI-conformant schemas.