add-endpoint

Create FastAPI endpoints following existing router and testing conventions.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/SameerG7/synthesis-hackathon-aibom --skill add-endpoint-sameerg7
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-endpoint
Source: https://github.com/SameerG7/synthesis-hackathon-aibom/tree/main/.claude/skills/add-endpoint
Command: npx skills add https://github.com/SameerG7/synthesis-hackathon-aibom --skill add-endpoint-sameerg7

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps developers add a new API endpoint that strictly adheres to the project's routing, error handling, and testing conventions, ensuring consistency and reducing integration issues.

Core Features & Use Cases

  • Pattern discovery: Analyzes existing routers and app registration to mirror conventions.
  • Endpoint scaffolding: Generates or guides code for new routes with appropriate imports, error handling, and response shapes.
  • Testing guidance: Provides steps to write tests following the repository's testing patterns.
  • Use Case: A team wants to introduce a new CRUD route for a resource without breaking existing validation or error shapes.

Quick Start

Create a new endpoint by providing the HTTP method, path, and description, then follow the project patterns to implement the route.

Frequently Asked Questions about add-endpoint

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new API endpoint to a FastAPI project?

To add a FastAPI endpoint, you provide the HTTP method, path, and description, then scaffold the route by following existing project conventions for imports, error handling, and response formats to ensure consistency.

How do I maintain consistent error handling and response formats across multiple FastAPI routers?

You maintain consistent FastAPI error handling by analyzing existing routers and app registration patterns before scaffolding, ensuring new routes mirror established import styles and response shapes to reduce integration issues.

What's the best way to scaffold a CRUD route in FastAPI without breaking existing validation?

The best way to scaffold a FastAPI CRUD route is to review current code conventions first, then generate the new endpoint with matching validation, error handling, and testing patterns to prevent breaking existing API shapes.

How do I write tests for a new FastAPI endpoint that match my repository's existing patterns?

You write tests for a new FastAPI endpoint by following the testing guidance provided during scaffolding, which instructs you to review and align with the repository's established testing patterns before implementation.

Does this endpoint scaffolding approach work with existing FastAPI routers and app registration?

Yes, the scaffolding approach works with existing FastAPI routers by performing pattern discovery on current app registration and routing conventions to mirror imports, error handling, and response formats.

Why do my new FastAPI endpoints have inconsistent response shapes and import styles?

New FastAPI endpoints become inconsistent when code generation skips reviewing existing routers first, leading to misaligned import styles, error handling, and response formats that break project conventions.