Bruno API Automation: Turn API definitions into sustainable CI regression
An API collection is hard to trust when it depends on one laptop’s variables and a remembered execution order. Bruno works best when requests, environments, and assertions live in reviewable source control.
The Bruno API Testing Skill structures collection data and environment boundaries so local debugging and CI exercise the same contract.
This guide organizes the practice around clear inputs, boundaries, and outputs, so the next person can act on the conclusion with confidence.
Awesome QA Skills organizes Skills by language and testing stage. The series overview covers repository structure and shared installation options; this guide stays with API Test Bruno.
Read the source Skill first
The main prompt covers Input parsing order, Defaults (use these unless the user specifies otherwise), Gotchas, Pre-delivery checklist, Quality bar. Those headings are navigation; the project artifacts still provide the facts.
The source directory contains 8 example files, 4 references, 5 script entries. Start with Bruno testing example, Framework guide.
From artifacts to a runnable entry point
The task is concrete: Generate a Bruno collection, environment, and assertions from OpenAPI, then run it in CI
The input can stay short, but it needs facts.
Journey: sign in → create order → pay → read result
Environment: staging
Available artifacts: interface definition, test account, CI command
Deliverable: bruno/orders/collection.bru, plus the local command and failure evidenceThe Skill should confirm versions, authentication, and data cleanup before generating files. This output fragment demonstrates structure; it does not claim a run occurred.
tool: Bruno
entry: bruno/orders/collection.bru
checks: 401/403 boundaries, error schema, request idempotency
run_evidence: pendingKeep run_evidence pending until a command, report, or trace exists. The source prompt also calls out Input parsing order, Defaults (use these unless the user specifies otherwise), Gotchas.
Turn the fragment into a project skeleton
A code fragment becomes useful when its path, command, and artifacts are explicit. Start with one journey.
bruno/orders/collection.bru
├── scenario and assertions
├── data or feeder
├── environment configuration
└── failure artifacts written to artifacts/Use one reproducible local and CI command.
bru run bruno/orders --env stagingKeep collection files in Git; inject secrets through the environment.
Definition of integrated
| Check | Minimum bar | If it fails |
|---|---|---|
| Repeatability | A run does not depend on leftover data | Rework setup and cleanup |
| Diagnosis | CLI summary and exported JUnit report identifies the same run | Add a run ID and build ID |
| CI decision | Process exit status matches the quality gate | Fix reporter or threshold configuration |
| Maintenance | Shared authentication and setup have one edit point | Extract a fixture, specification, or user action |
Expand into errors, boundaries, and concurrency only after this journey behaves the same locally and in CI.
A prompt you can adapt
Replace the bracketed fields with project facts. Specific material leaves less room for guessing.
Use the api-test-bruno Skill.
Task: Generate a Bruno collection, environment, and assertions from OpenAPI, then run it in CI
Version and environment: [requirement / build / environment]
Inputs: [file paths or links]
Scope: [included and excluded journeys]
Constraints: [accounts, data, time, compliance]
Check framework version, paths, and authentication first. Generate the smallest runnable entry, command, and artifact list. Mark unexecuted code as not verified.
Finish with open questions. Do not invent missing facts.Use the first pass to inspect structure and gaps. Supply missing material before asking for the handoff-ready artifact.
Advanced use, from one call to a maintained flow
Separate commit-safe environment values from CI secrets. Group CLI runs by business domain and retain request name, environment, and data row on failure.
Keep a baseline for duration, pass rate, flaky cases, failure classes, and evidence completeness. Pass rate alone hides too much.
A three-Skill chain
requirements-analysis → api-test-bruno → test-reporting
| Handoff | Payload | Receiver check |
|---|---|---|
| Upstream to api-test-bruno | Source versions, scope, risks, open questions | API Test Bruno staleness and conflicts |
| api-test-bruno to downstream | Primary artifact, evidence index, unfinished work | API Test Bruno executability and owners |
| Feedback to api-test-bruno | Runs, defects, new risks | API Test Bruno baseline and regression update |
Do not paste three complete outputs into one large prompt. Give API Test Bruno a structured summary and accessible source artifacts. It saves context and makes defects traceable.
Team gates
| Gate | Check | Failure action |
|---|---|---|
| api-test-bruno input | Version, environment, owner, accessible sources | Stop API Test Bruno and list gaps |
| api-test-bruno artifact | Material claims carry basis and status | Return API Test Bruno for evidence |
| api-test-bruno execution | Command, exit status, report are reproducible | Classify infrastructure or test failure |
| api-test-bruno decision | Residual risks have accepter and date | Do not enter the next stage |
Review API Test Bruno adoption, human edit rate, unsupported claims, and failure-to-diagnosis time each sprint. Record a baseline for several cycles before setting targets.
Common failure modes for this tool family
- Code is generated without a run command, leaving the next person unable to verify it.
- Versions and dependencies are omitted even though Bruno configuration and reporters change.
- Tests share dirty data. API, UI, and performance suites all suffer from leftovers.
- One green run is described as long-term stability. Keep reports, logs, and retry evidence.
Install and invoke
Install the individual Skill. The series overview carries the longer installation explanation.
npx skills add https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-test-bruno -gInvoke it with “Use the api-test-bruno Skill,” then attach the real artifacts.
Two practical questions
Will API Test Bruno hand me a runnable project?
With complete definitions, versions, paths, and dependencies, it can generate a strong starting point. You still need to install dependencies, run it in your repository, and fix environment differences.
When should generation stop?
Stop when authentication, test data, or the target version is unknown. More generation would only produce a polished guess.
What should be checked first after generation?
Confirm that the entry command discovers the target file and writes failure artifacts to the agreed path. Expand coverage after that works.
Can it enter a release gate immediately?
Wait until local and CI runs use the same command, data resets cleanly, and evidence is traceable.
Run API Test Bruno against one real artifact and keep the input, output, and review notes. The fragments here establish structure; project evidence must still come from the project.
References
- Awesome QA Skills project:https://github.com/naodeng/awesome-qa-skills
- Awesome QA Skills series overview:https://inaodeng.com/en/blog/ai-testing/introduction_of_awesome_qa_skills/
- Bruno testing example:https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-test-bruno/examples/bruno
- api-test-bruno (EN) supporting references:https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-test-bruno/references/framework-spec.md
- Awesome QA Skills: api-test-bruno (EN) Skill source:https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-test-bruno
- API Test Bruno Skill details:https://inaodeng.com/en/qaskills/api-test-bruno/