Help us improve
Share bugs, ideas, or general feedback.
From cc-useful
This skill should be used when the user asks to "create integration docs", "generate API spec for frontend", "hand off backend to frontend", "prepare API contract for frontend team", "create API handoff document", "document backend APIs for frontend agent", "backend-frontend handoff", or when backend implementation is complete and needs to be documented for a frontend AI agent to consume. Not for standalone OpenAPI/Swagger generation or non-REST API documentation.
npx claudepluginhub jhleee/cc-useful --plugin cc-usefulHow this skill is triggered — by the user, by Claude, or both
Slash command
/cc-useful:backend-handoffThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Generate a structured integration document from backend code analysis.
Generates API documentation from code, covering endpoints, parameters, request/response examples, authentication, error handling, and usage guidelines. Supports REST, GraphQL, and WebSocket APIs.
Generates API docs from code or OpenAPI specs with examples, schemas, interactive Swagger UI/Redoc, and exports to Markdown, PDF, Postman, SDKs.
Generates OpenAPI specs and interactive API docs with Swagger/Redoc. Handles spec-first contracts and code-first auto-generation from Express, FastAPI, NestJS, Spring Boot.
Share bugs, ideas, or general feedback.
Generate a structured integration document from backend code analysis. The output targets a frontend AI agent as its reader — not a human developer. The document must be goal-oriented, unambiguous, and immediately actionable.
Scan the codebase to locate backend source files. Search in order:
**/routes/**, **/controllers/**, **/api/**, **/*.controller.*, **/*.route.*, **/*.router.***/models/**, **/schemas/**, **/entities/**, **/types/**, **/*.model.*, **/*.schema.*, **/*.entity.***/middleware/**, **/middlewares/**, **/guards/**, **/interceptors/****/config/**, .env.example, **/app.*, **/main.*, **/server.***/swagger.*, **/openapi.*, **/*.swagger.*, **/api-docs*Read each discovered file. Extract:
Before generating the document, present analysis results to the user for confirmation.
Use AskUserQuestion to verify:
Do not proceed to Phase 3 until user confirms.
Generate a Markdown document following the template in references/document-template.md.
Project root resolution: Nearest ancestor directory containing .git, or current working directory as fallback.
Output rules:
{project_root}/FRONTEND_INTEGRATION.md unless user specifies otherwiseSection generation order:
After generation, verify the document:
{placeholder} values remain in the outputFramework-agnostic analysis. Common patterns (non-exhaustive — for unlisted frameworks, use the fallback rule below):
| Pattern | Indicator | Extract |
|---|---|---|
| Express/Koa | router.get(), app.post() | Method + path from call |
| FastAPI | @app.get("/path"), @router.post | Decorator args |
| Spring | @GetMapping, @PostMapping | Annotation values |
| NestJS | @Get(), @Post(), @Controller() | Decorator args + controller prefix |
| Django REST | urlpatterns, ViewSet | URL conf + ViewSet actions |
| Rails | resources :name, get "/path" | routes.rb entries |
| Go (Gin/Chi) | r.GET(), r.Route() | Method calls |
| ASP.NET | [HttpGet], [Route] | Attribute values |
For unrecognized frameworks: infer endpoints from HTTP method keywords and path string literals.
The generated document succeeds when a frontend AI agent can:
references/document-template.md — Complete output document template with all sections, placeholder formats, and usage notes. Consult when generating the final document.examples/example-output.md — A completed integration document generated from a sample Express + JWT CRUD API. Use as a concrete reference for output quality and format.