Agent skill · writing content · aiskillstore
bruno-api
Generate comprehensive API endpoint documentation from Bruno (.bru) files by mapping requests to a Django4Lyfe/Diversio-style backend implementation (Django REST Framework or Django Ninja), including auth/permissions, multi-tenant filtering, request/response schemas, and line-numbered code references. Use for single endpoints, directory scans of .bru files, or when writing docs to a specific output path.
Why this skill is useful
Generates detailed API documentation from .bru files, including specific implementation details and request/response schemas that the AI wouldn't reliably generate on its own.
What it needs
Requires bash installed locally. About 4k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Bruno API Documentation Generator Skill Inputs & Modes This Skill expects one of: A path to a single Bruno file (usually .bru), OR --scan <dir> to analyze all .bru files under a directory. Optional flags: --dry-run – produce an analysis plan only (no deep codebase search). --output <path> – write the generated markdown documentation to a file. If inputs are missing or ambiguous, ask the user to confirm: Which .bru file(s) to analyze. Whether they want --dry-run or full documentation. Whether an output file should be written. Output Shape & Severity Tags Dry-run output Return a short plan containing: Endpoint summary: method, URL, auth, and any detected params/body. Where you will look in the Django codebase (specific file paths/directories). Which documentation sections will be generated. Complexity notes (e.g., “DRF ViewSet + serializer” vs “Ninja router + schema”). Full documentation output Generate a single markdown document for each endpoint using this structure: # <Endpoint Name> <METHOD> <URL Pattern> Authentication, Permissions, Multi-tenant ## Overview ## Request (headers + params/body with types/validation) ## Response (success example + common error cases) ## Implementation Details (URL config + view + serializer/schema; always with file.py:line) ## Business Logic (step-by-step, include side effects like tasks/external calls) ## Frontend Integration (TypeScript types + call example + React Query hook example) ## Testing (Bruno tests + edge cases + required fixtures/data) ## Notes (perf considerations, related endpoints, rollout notes) Use severity tags only when something prevents correctness/completeness: [BLOCKING] – cannot locate the endpoint implementation or critical auth/permission logic. [SHOULDFIX] – documentation gaps due to missing/incomplete source details (e.g., response shape unclear). [NOTE] – optional improvements, related endpoints, refactors, or performance observations. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/bruno-api