backend-to-frontend-handoff-docs_skill

Overview

This skill generates copy-paste-ready API handoff documentation for frontend developers after backend work is complete. It produces a dense, structured markdown document that contains business context, endpoints, DTOs, validation, edge cases, and integration guidance. Use it to remove back-and-forth questions and let frontend engineers or their AI integrate confidently.

How this skill works

The skill inspects completed backend API surfaces (endpoints, request/response DTOs, auth rules, validation and discovered edge cases) and fills a strict markdown template tailored for frontend consumption. It outputs a single markdown block with example payloads, enums, validation rules, recommended flows, and test scenarios. For simple CRUD APIs it can emit a minimal shortcut: endpoint, method, and example request/response JSON.

When to use it

• After backend tickets are implemented and merged
• When you need a frontend-ready API spec for integration or UI work
• If a frontend developer asks for "create handoff" or "document API"
• Before handing work off to QA or to an AI-based frontend agent
• When changes require an updated iteration (bump version suffix)

Best practices

• Include concrete example request and response JSON for every endpoint
• State exact auth requirements and token scopes per endpoint
• Mirror backend validation rules in the frontend for better UX and fewer round trips
• Note any non-obvious business rules, soft-deletes, and default filters explicitly
• Increment the document iteration suffix (e.g., -v2) when re-running after feedback

Example use cases

• Document a new resource CRUD API so frontend can scaffold forms and list pages
• Handoff a multi-step submission flow with polling and WebSocket events
• Create a spec for an endpoint with complex DTOs and conditional validation
• Provide acceptance-test scenarios for frontend QA to validate integration
• Produce a compact CRUD shortcut spec for simple endpoints