← ClaudeAtlas

uselink-api-docslisted

Scan backend controllers/routes, generate API documentation as HTML, and publish to uselink. Use when the user wants to share API docs with frontend devs, partners, or stakeholders who need to understand the API contract.
spartan-hieuvo/claude-skills · ★ 0 · API & Backend · score 73
Install: claude install-skill spartan-hieuvo/claude-skills
# API Docs → Uselink Scan a codebase for API endpoints, generate clean API documentation as HTML, and publish to uselink. ## When to Use - "Generate API docs and share them" - "Document our endpoints for the frontend team" - "Share the API contract with the mobile dev" - "What endpoints do we have? Publish a reference." ## Prerequisites ```bash which uselink || echo "MISSING" test -f ~/.uselink/config.json && echo "OK" || echo "NO_CONFIG" ``` ## Workflow ### 1. Detect framework and find endpoints **Micronaut/Kotlin:** ```bash grep -rn "@Controller\|@Get\|@Post\|@Put\|@Delete" \ --include="*.kt" -l | grep -v build | grep -v test ``` **Express/Node:** ```bash grep -rn "router\.\(get\|post\|put\|delete\)\|app\.\(get\|post\|put\|delete\)" \ --include="*.ts" --include="*.js" -l | grep -v node_modules | grep -v test ``` **FastAPI/Python:** ```bash grep -rn "@app\.\(get\|post\|put\|delete\)\|@router\.\(get\|post\|put\|delete\)" \ --include="*.py" -l | grep -v __pycache__ | grep -v test ``` **Spring/Java:** ```bash grep -rn "@RestController\|@GetMapping\|@PostMapping\|@RequestMapping" \ --include="*.java" --include="*.kt" -l | grep -v build | grep -v test ``` ### 2. Read each controller For each controller file: - Extract the base path (e.g., `@Controller("/api/v1/documents")`) - Extract each endpoint: method, path, query params, body type, return type - Extract auth requirements (e.g., `@Secured`, middleware) - Read the request/response DTOs to get field names a