grey-haven-api-design

Standardize RESTful API endpoint design for FastAPI and TanStack Start backends.

2|1|Updated Sep 16, 2024
One-click install
npx skills add https://github.com/mvandermeulen/nvim --skill grey-haven-api-design-mvandermeulen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: grey-haven-api-design
Source: https://github.com/mvandermeulen/nvim/tree/main/.claude/skills/api-design-standards
Command: npx skills add https://github.com/mvandermeulen/nvim --skill grey-haven-api-design-mvandermeulen

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill provides a standardized framework for building consistent, secure, and scalable RESTful APIs, eliminating guesswork in endpoint design, error handling, and multi-tenant isolation.

Core Features & Use Cases

  • Standardized REST Patterns: Enforces consistent URL structures, HTTP verb usage, and status code conventions across FastAPI and TanStack Start projects.
  • Security & Multi-tenancy: Implements mandatory tenant-aware repository patterns and secure JWT-based authentication to prevent cross-tenant data leaks.
  • Validation & Documentation: Automates Pydantic schema validation and OpenAPI documentation generation to ensure API reliability and developer clarity.

Quick Start

Use the grey-haven-api-design skill to generate a new CRUD endpoint for the user resource following the repository pattern.

Frequently Asked Questions about grey-haven-api-design

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

FAQPage Schema
How do I implement a multi-tenant API in FastAPI?

Implement multi-tenant APIs in FastAPI using standardized tenant-aware repository patterns. This ensures isolated data access per tenant and applies secure JWT-based authentication to prevent cross-tenant data leaks across REST endpoints.

What is the best way to structure RESTful endpoints for consistency across backend projects?

Standardize RESTful endpoint structures by enforcing consistent URL patterns, HTTP verb usage, and status code conventions. This framework eliminates design guesswork, ensuring consistent API behavior across FastAPI and TanStack Start backend projects.

How do I automate Pydantic validation and OpenAPI documentation generation?

Automate Pydantic validation and OpenAPI documentation by enforcing schema validation within your REST API framework. This integration ensures API reliability and developer clarity without requiring manual documentation efforts.

Does this API design approach support TanStack Start backends?

Yes, this API design approach supports TanStack Start backends. It standardizes RESTful endpoint design, tenant-aware repository patterns, and consistent error handling mechanisms seamlessly across both TanStack Start and FastAPI environments.

How do I configure rate limiting and CORS for secure RESTful APIs?

Configure rate limiting and CORS for secure RESTful APIs by applying mandatory security best practices. This framework ensures compliance with standard security configurations directly during the API design and implementation process.