Skip to content

docs: document api docs and rate limiting in readme #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heitorrsdev merged 1 commit into from
Apr 26, 2026
Merged

docs: document api docs and rate limiting in readme #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,18 @@ Implemented and in-progress use cases:

---

## API Documentation

The core system exposes an interactive API documentation using Swagger. When the application is running, the documentation is available at `/docs`. This allows for exploration of all available endpoints, request schemas, and response types.

---

## Rate Limiting

To ensure stability and protect the system against abuse, the API implements request rate limiting. Using NestJS Throttler, limits are enforced at the HTTP layer, mitigating brute-force attempts and denial-of-service scenarios.

---

## Documentation

* ADRs (architectural decisions): [`docs/adr`](./docs/adr)
Expand Down
Loading