api-check

Automates FastAPI endpoint health checks for async usage, Pydantic v2 integration, caching, and error handling, generating a structured report.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/rayvoidx/social-trend-agent --skill api-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-check
Source: https://github.com/rayvoidx/social-trend-agent/tree/main/.claude/skills/api-check
Command: npx skills add https://github.com/rayvoidx/social-trend-agent --skill api-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps verify the health and quality of FastAPI endpoints by scanning for async usage, Pydantic v2 configuration, caching, and consistent error handling, enabling faster debugging and reliable APIs.

Core Features & Use Cases

  • Endpoint Inventory: Enumerates all API routes.
  • Async & Pydantic Validation: Checks for async usage and Pydantic v2 configs.
  • Caching & Errors: Validates caching implementation and standardized error responses.
  • Output Report: Generates a structured API health report.

Quick Start

Run the api-check skill to generate an API health report for the repository.

Frequently Asked Questions about api-check

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

FAQPage Schema
How do I audit FastAPI endpoints for async usage and consistency?

Run api-check to scan all FastAPI routes and verify async/await implementation across endpoints. The Skill generates a health report identifying which routes lack proper async definitions, ensuring consistent async patterns throughout your API.

Can I validate Pydantic v2 configuration across my FastAPI routes?

Yes, api-check validates Pydantic v2 ConfigDict support across all endpoints. It checks that your models properly use Pydantic v2 configuration patterns and reports endpoints missing correct v2 integration.

What should I check for in my FastAPI error handling?

Error handling consistency matters: standardized error response formats, correct HTTP status codes, and proper exception handling across routes. api-check validates these patterns and reports deviations in a structured health report.

How do I identify caching and rate limiting gaps in my FastAPI API?

api-check scans endpoints to validate caching strategies and rate limiting considerations. It produces an actionable report highlighting routes missing proper cache implementation or rate limit handling.

Does api-check work with existing FastAPI projects without modification?

Yes, api-check enumerates all routes in your FastAPI application and performs automated health checks across the entire endpoint inventory without requiring code changes to your routes.

What's the output format of the API health report?

api-check generates a structured, actionable health report detailing findings across async consistency, Pydantic v2 integration, error handling standardization, response models, and caching validation for each endpoint.