graasp / graasp/graasp-api

Use bruno for API collection documentation

Open
#865 0 comments 0 reactions 1 assignee Claimed by @spaenleh View on GitHub
chore
Dominant language
TypeScript
Stars
7
Forks
5
PR merge metrics
No merged PRs in 30d

Description

[Bruno](https://www.usebruno.com/) is an API collection tool similar to Postman but with more benefits. It allows to store an endpoint in a single file making sharing and diffing of the collections easier and friendlier.

The idea would be to include it in the source code, so any new developer could get up and running faster and APIs could be kept up to date with more ease.

Ideally it could also be synched with a mock database seeded automatically so the calls work out of the box.
The idea would be to create a local environnement file when seeding the mock database, and that environnement should be used by bruno by default.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.