-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathrecipe.spec.txt
27 lines (26 loc) · 1006 Bytes
/
recipe.spec.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Functional Requirements
- Users can login ✅
- Users can register ✅
- Only registered users can create recipes ✅
- Users can categorize recipes ✅
- Users can share recipes
- Users can search recipes
- Search by category ✅
- Search by difficulty ✅
- Search ny title ✅
- Random search ✅
- Search by cookingTime ✅ and prepTime range ✅
- Search by ingredients ✅
- Only recipe owner can modify/ update recipes ✅
- Only recipe owner can delete recipes ✅
- Users can comment/ rate recipes
Non-Functional Requirements
- Response time should be below 50ms
- High availability upto 99.999
- Error handling, ensure to respond with the accurate error message ✅
- Security, ensure all protected routes are guarded ✅
- A well organized code-base that is easy to understand and modify ✅
- API documentation for the endpoint usability ✅
- Best RESTful API design practices ✅
- Scalability, registered users, recipes and traffic
- Observability: e.g morgan ✅