# Document Bruno API Endpoints

Bruno API collections often drift from backend behavior. This skill maps .bru requests to Django or Ninja code and produces endpoint documentation with references.

## Install

```bash
npx skillstore add diversioteam/bruno-api
```

## Metadata

- Status: approved
- Slug: diversioteam-bruno-api
- Skillstore revision: r1
- Version status: missing
- Tree hash: b2a73e4ace0da6e83ffb9179a590ac57248f876e39af5731019e0f9af5f01d03
- Author: DiversioTeam
- GitHub username: DiversioTeam
- License: MIT
- Repository: https://github.com/DiversioTeam/agent-skills-marketplace/tree/main/plugins/bruno-api/skills/bruno-api
- Ref: 72d5025b022c77f7a51bdf5c1637c689c80e89d1
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/diversioteam-bruno-api
- Manifest: https://skillstore.pages.dev/api/skills/diversioteam-bruno-api/manifest

## Capabilities

- Parses single Bruno files or scans directories for multiple .bru files.
- Extracts HTTP methods, URLs, headers, query parameters, path parameters, and request bodies.
- Maps endpoints to Django REST Framework views, serializers, permissions, and queryset filtering.
- Maps Django Ninja routes to routers, endpoint functions, schemas, auth, and tenant scoping.
- Generates markdown documentation with implementation references and severity notes.
- Can return documentation in chat or write it to a chosen output path.

## Use Cases

- Document an Existing Endpoint: Turn one Bruno request into a backend-linked endpoint document with request, response, auth, and implementation details.
- Review API Coverage: Scan a directory of Bruno files and identify documentation gaps across multiple backend endpoints.
- Prepare Frontend Integration Notes: Generate endpoint guidance that includes request contracts, response expectations, and frontend integration examples.

## Prompt Templates

### Document One Bruno File

```
Use bruno-api on api/users/get-user.bru and return the documentation in chat.
```

### Create a Dry Run Plan

```
Use bruno-api with --dry-run for api/accounts/update-profile.bru. Show where you will inspect the Django implementation.
```

### Scan a Bruno Directory

```
Use bruno-api with --scan api/bruno/admin. Group the generated endpoint documentation by Bruno file.
```

### Write Linked Documentation

```
Use bruno-api with --scan api/bruno/pulse --output docs/api/pulse-endpoints.md. Include auth, tenant filtering, and code references.
```

## Limitations

- It expects Django REST Framework, Django Ninja, or similar project conventions.
- It needs readable Bruno files and backend source files in the workspace.
- It may mark gaps when response shapes or auth behavior are unclear.
- It does not execute API requests or verify live server behavior.

## Best Practices

- Run a dry run first when the endpoint route is hard to locate.
- Keep Bruno files and backend source code in the same workspace.
- Review generated assumptions before publishing documentation to other teams.

## Anti Patterns

- Do not use it when the backend source code is unavailable.
- Do not treat generated examples as live API test results.
- Do not write output files outside the active project workspace.

## Security Audit

- Audited at: 2026-07-06T11:28:52.662\+00:00
- Summary: All static external command findings are false positives caused by Markdown backticks in documentation text. The skill describes reading Bruno files, searching Django code, and optionally writing generated documentation, with no evidence of prompt injection or malicious intent.

## Stats

- Views: 175
- Downloads: 11
- Favorites: 0
- Popularity score: 0