bruno-endpoint-creation_skill

This skill helps you create Bruno REST API endpoints with proper environment config, authentication, and documentation for reliable testing.

Shell

31

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill steveclarke/dotfiles --skill bruno-endpoint-creation

SKILL.md2.9 KB

Overview

This skill creates professional Bruno REST API endpoint configurations with secure authentication, environment setup, and clear documentation. It standardizes collection-level auth, request/response handling, and reusable environment variables so Bruno collections are predictable and safe. Use it to speed up API testing, onboarding, and CI-friendly endpoint maintenance.

How this skill works

It generates Bruno-friendly files and snippets for environments, endpoints, auth blocks, request bodies, query/path params, and scripts. It recommends collection-level bearer auth, secret handling for production, pre-request dynamic data generation, and post-response extraction using bru.setVar()/bru.setEnvVar(). It also provides docs templates and test sequences to validate expected status codes and response shapes.

When to use it

Setting up a new Bruno collection for API testing
Creating or standardizing new REST endpoints (CRUD)
Configuring collection-level authentication and secrets
Preparing environment-specific configs (local, staging, production)
Building test sequences and response-extraction scripts

Best practices

Define auth at collection level (auth: inherit) to follow DRY and simplify maintenance
Store production secrets in vars:secret and never hardcode API keys in source files
Use bru.setVar() for ephemeral runtime values and bru.setEnvVar() for persistent environment changes
Document each endpoint with required/optional fields, validation rules, and example responses
Organize collections into Environments, Authentication, Resources, and Health folders for clarity

Example use cases

Create Local.bru with baseUrl and dev apiKey for local testing
Configure collection-level bearer token and inherit it across create/list/get/update/delete endpoints
Add pre-request script to generate unique emails and randomIds for test runs
Post-response script stores created resource ID to run subsequent GET/PATCH/DELETE steps
Prepare a production environment file with vars:secret and read-only health checks for deployment monitoring

FAQ

Use bru.setVar() for temporary values needed only during a single run (extracted IDs). Use bru.setEnvVar() when you want values persisted across runs and visible in the Environment tab.

How do I handle different auth for a single endpoint?

Only apply individual endpoint auth when it deviates from the collection. Define auth blocks (bearer, basic, headers) inside the endpoint and avoid duplicating secrets in source; reference environment variables instead.