This skill streamlines the process of documenting backend API endpoints by generating and correcting @extend_schema decorators, response TypedDicts, and request parameters. It helps developers maintain accuracy between runtime behavior and declared schemas, assists in migrating legacy JSON documentation to drf-spectacular, and facilitates the promotion of private endpoints to public status. By identifying type drift and ensuring strict validation against live endpoints, it ensures that the generated API specification remains a reliable source of truth for SDKs and external developers.
主要功能
01Generates and fixes @extend_schema decorators for OpenAPI compliance
02Migrates legacy JSON-based API documentation to modern drf-spectacular paths
03850 GitHub stars
04Automates the creation of TypedDict response schemas to prevent type drift
05Manages API promotion workflows including ownership, status flips, and scope updates
06Validates API specs against runtime responses and live endpoints using curl and jq
使用场景
01Adding comprehensive OpenAPI documentation and TypedDicts to a new Sentry endpoint
02Correcting type mismatches where the actual API response differs from the declared schema
03Promoting a private or experimental API endpoint to public status with proper validation