Skip to content

🎉 REST API Documentation with Bruno - #2991

Merged
shewa12 merged 2 commits into
devfrom
api-doc
Sep 8, 2026
Merged

🎉 REST API Documentation with Bruno#2991
shewa12 merged 2 commits into
devfrom
api-doc

Conversation

@harunollyo

Copy link
Copy Markdown
Collaborator

Summary

Added REST API documentation and request collections using Bruno under tutor/docs/api.

Benefits

  • Keeps API documentation alongside the codebase.
  • Git-friendly and easy to review in PRs.
  • Supports local and production environments.
  • Avoids duplicating requests between environments.
  • Makes API requests easy to maintain and share across the team.
  • Can be used for future API testing and CI automation.

Why Bruno instead of Postman?

  • Git-first: Bruno collections are plain files stored directly in the repository.
  • Easy code review: API changes appear as normal Git diffs.
  • No separate workspace dependency: Developers get the collection by cloning the repository.
  • Simple collaboration: Documentation and API requests are versioned with the project.

This keeps the API documentation version-controlled, maintainable, and close to the source code.

@harunollyo
harunollyo requested a review from shewa12 September 8, 2026 06:03
@harunollyo harunollyo self-assigned this Sep 8, 2026
@shewa12
shewa12 merged commit dab181b into dev Sep 8, 2026
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants