Skip to content

Commit 7ff5ad1

Browse files
authored
Update README.md
1 parent 2ab1227 commit 7ff5ad1

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# Recipe-Sharing-API-Python-in-FastAPI
2-
A full API service for recipes. This application is built using Python, MSSQL Database, SQL Queries, Docker, and FastAPI providing a comprehensive solution for managing and sharing your recipes.
1+
> markdown
2+
3+
# Recipe API
4+
5+
This project implements a simple recipe management system using Flask for the API and MSSQL for the database. It allows users to add, retrieve, update, and delete recipes, rate recipes, and add comments.
6+
7+
## Getting Started
8+
9+
To run the application, make sure you have Docker installed on your machine.
10+
11+
1. Clone this repository:
12+
13+
> css
14+
15+
# git clone https://github.com/vanelli0n/recipe-api.git
16+
17+
2. Navigate to the project directory:
18+
19+
> arduino
20+
21+
#cd recipe-api
22+
23+
3. Build and run the application using Docker:
24+
25+
> sql
26+
27+
# docker-compose up --build
28+
29+
4. Access the API at http://localhost:5000
30+
31+
## API Endpoints
32+
33+
- POST /recipes/: Add a new recipe.
34+
- GET /recipes/: Retrieve a list of all recipes, sorted by most recent.
35+
- GET /recipes/<recipe_id>: Retrieve details of a specific recipe by its ID.
36+
- PUT /recipes/<recipe_id>: Update a specific recipe by its ID.
37+
- DELETE /recipes/<recipe_id>: Delete a specific recipe by its ID.
38+
- POST /recipes/<recipe_id>/ratings/: Rate a specific recipe.
39+
- POST /recipes/<recipe_id>/comments/: Comment on a specific recipe.
40+
- GET /
41+
42+
### recipes/<recipe_id>/comments/: Retrieve all comments for a specific recipe.

0 commit comments

Comments
 (0)