bruno-api

Generate Markdown API documentation from Bruno (.bru) files.

3|4|Updated Nov 30, 2025
One-click install
npx skills add https://github.com/DiversioTeam/agent-skills-marketplace --skill bruno-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bruno-api
Source: https://github.com/DiversioTeam/agent-skills-marketplace/tree/main/plugins/bruno-api/skills/bruno-api
Command: npx skills add https://github.com/DiversioTeam/agent-skills-marketplace --skill bruno-api

SYSTEM DOCUMENTATION & REQUIREMENTS

Bruno API Documentation Generator converts Bruno (.bru) files into endpoint docs for a Django4Lyfe backend, mapping requests to DRF or Ninja implementations, including auth/permissions, multi-tenant filtering, and code references.

Core Features & Use Cases

  • Endpoint mapping: ties Bruno definitions to real route implementations.
  • Structured docs: documents authentication, permissions, multi-tenant constraints, request/response schemas, and code references.
  • Frontend integration: TypeScript types and example calls for frontend consumption.

Quick Start

Run Bruno API to generate docs for a single Bruno file or use --scan to analyze a directory and write output with --output.

Frequently Asked Questions about bruno-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from Bruno files?

Bruno API documentation generator converts .bru files into structured endpoint docs by mapping requests to Django backend implementations. Run the tool on single files, scan directories with --scan, and write output with --output to produce Markdown documentation including authentication, permissions, and code references.

Can I document Django REST Framework and Django Ninja endpoints with Bruno?

Yes. Bruno API maps requests defined in .bru files to both DRF and Ninja route implementations, automatically extracting and documenting endpoint behaviors, request/response schemas, authentication methods, and permission constraints tied to your actual backend code.

What information does Bruno API documentation include?

Generated docs cover authentication and permissions, multi-tenant filtering logic, request and response schemas, TypeScript types for frontend integration, example API calls, and line-numbered code references pointing to real route implementations in your Django backend.

How do I preview documentation changes before writing files?

Use the --dry-run mode to preview the analysis and generation plan without writing output. This lets you review how Bruno requests map to backend endpoints and validate schema extraction before committing documentation to disk.

Does Bruno API work with multiple files and directory scans?

Yes. Process single .bru files directly, use --scan to analyze entire directories of Bruno request files, and specify --output to write consolidated documentation to your chosen location with all endpoints documented in one structured Markdown output.

Why document API endpoints from Bruno instead of manually?

Bruno API eliminates manual documentation drift by generating docs directly from .bru request definitions and tying them to real backend code. This ensures docs stay synchronized with actual implementations, reduces maintenance overhead, and captures authentication, permissions, and multi-tenant logic automatically.