Skip to content

docs: add deployed backend link to README #31

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

Open
Bhoomi-112 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add deployed backend link to README #31

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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ Frostiq's BakeryBackend is a FastAPI-based backend service for managing user fav
- SQLite database (file always stored in `BakeryBackend/`)
- Ready for unit/integration testing with pytest


## Deployed Application

You can explore and test all API endpoints using the built-in **Swagger UI**:
[https://frostiq-bakery-backend.onrender.com/docs](https://frostiq-bakery-backend.onrender.com/docs)

---

## API Testing via Swagger UI

Swagger provides an interactive way to test the API:

### Available Endpoints:
- `GET /favorites/{user_id}` – Fetch all favorite items for a user
- `POST /favorites` – Add a new item to favorites
- `DELETE /favorites/{user_id}/{item_id}` – Remove an item from favorites

You can view request/response formats and try out the endpoints directly in your browser.

## Setup Instructions
1. **Clone the repository:**
```bash
Expand Down