Giter VIP home page Giter VIP logo

littlelemon-api's Introduction

API Final Project Documentation

Description

The LittleLemon API is the final assignment for the APIs Course part of the Meta BackEnd Developer Professional Certificate on Coursera.

The API endpoints for this project provide the functionality to create, edit and delete users, roles for each user, such as Customer, Delivery Crew or Manager, menu items, categories for menu items, shopping cart, and orders. Every API endpoint has authorization and permissions constraints as well as throttling, pagination, and filtering.

Project Structure

This project consists mainly of two apps, littlelemon and api.

littlelemon app

This app contains the models' definition to create the entity relationships required by the api app.

api app

This app contains the URLs dispatchers (routers), serializers, and views for every endpoint of the API. Additionally, it contains helpers classes that are inherited by class-based views.

config dir

This directory contains the configuration files of the project, such as the settings.py file and the urls.py file which contains the main URL dispatchers of the project.

Installation

Clone the repository

git clone https://github.com/Eadwulf/littlelemon.git && cd littlelemon

Create the virtual environment and install the dependencies

pipenv install

Note that I use Djoser but is included within the repository and not as a dependency. Djoser has some bugs that create a compatibility error with the latest version of DjangoRestFramework, I made the corrections that I needed and added it to the project as a local app to avoid such compatibility errors.

Database Setup

The project uses a PostgreSQL database. Configured as follows

DATABASES = {
    'default': {
    'ENGINE': 'django.db.backends.postgresql',
        'NAME': env('DATABASE_NAME'),
        'HOST': env('DATABASE_HOST'),
        'PORT': env('DATABASE_PORT'),
        'USER': env('DATABASE_USER'),
        'PASSWORD': env('DATABASE_PASSWORD'),
    },
}
💡 If you do not have an existing database and user to use with these settings, follow the instructions below and create new ones.

Enter The PostgreSQL Prompt

psql -U postgres -d postgres

Create The Database

CREATE DATABASE <database_name>;

Create The User

CREATE USER <username> WITH ENCRYPTED PASSWORD '<password>';

Modifying Connection Parameters

ALTER ROLE <database_user> SET client_encoding TO 'utf8';
ALTER ROLE <database_user> SET default_transaction_isolation TO 'read committed';
ALTER ROLE <database_user> SET timezone TO 'UTC';

Grant Permissions To The User

 GRANT ALL PRIVILEGES ON DATABASE <database_name> TO <username>;

Exit The Prompt

\q

Environment Variables

Create The Environment Variables File (.env)

In the Django project directory (chat-room-api/config/), create the .env file and add to it the following

DEBUG=<boolean_value>
DATABASE_NAME=<your_database_name>
DATABASE_HOST=<your_database_host>
DATABASE_PORT=<your_database_port>
DATABASE_USER=<your_database_user>
DATABASE_PASSWORD=<your_database_password>
💡 Be aware that django-environ is required. Such dependency should be installed by running pipenv install

Apply the migrations

python manage.py migrate

Run the server

python manage.py runserver


API endpoints and usage explanation

For the examples, I added code snippets for usage with curl, but feel free to use whatever tool suits you best. I also added filtering, searching, and ordering capabilities for some of the endpoints. The available fields for each endpoint are specified in the Endpoint section further below.

filtering

curl -X GET localhost:8000/api/menu-items?title=Latte \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {token}"

Note: Filtering searches for an exact match of the passed string to the query parameter. It returns an empty list if no matches were found.

Searching

curl -X GET localhost:8000/api/menu-items?search=coffe \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {token}"

Note: Search searches for any match of the passed string in all the lookup fields defined for the endpoint. It is case insensitive and may return results than partially or exactly match the passed string. For the above example, if there is an object with a title “Irish Coffee” and another with a category “Coffee”, both of them will be returned.

Ordering

curl -X GET localhost:8000/api/menu-items?ordering=price,title \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {token}"

Note: Ordering sorts the returns elements by the given criteria, by default it does it in ascending order, but it can be reversed by appending the minus sign (-) before the ordering criteria. In the above example, the ordering criteria are price and title, therefore all the returned elements are sorted in ascending order by price and then by title.

Filtering, searching, and ordering together

curl -X GET localhost:8000/api/menu-items?category=Coffee&search=coffee&ordering=price,title \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {token}"

All these functionalities can be used separately or in conjunction with one another. As shown in the above example, start appending the question mark (?), -after the endpoint URL-, add a query (such as search), and subsequently separate queries with an ampersand (&).

Here it is again:

?category=Coffee&search=coffee&ordering=-price,title

Roles

ROLE GROUP HAS RESTRICTION
Unauthenticated None YES
Customer Customer YES
Delivery Crew Delivery Crew YES
Manager Manager YES
System Administrator SysAdmin NO

Endpoints

Users

/api/users

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Unauthenticated POST Create a new user None
Manager GET, POST Retrieve the list of users and create new users Can’t retrieve the list of Admin users
Admin GET, POST Retrieve the list of users and create new users None

Usage:

curl -X GET localhost:8000/api/users \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/users \
   -H "Content-Type: application/json" \
   -d '{"username": "{username}", "password": "{password}", "email": "{email}"}'

Searching, ordering, and filtering fields:

▶️ username, first_name, last_name

/api/users/{userId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET, PATCH, DELETE Retrieve, edit, and delete the user Can’t reach other users
Delivery Crew GET, PATCH, DELETE Retrieve, edit, and delete the user Can’t reach other users
Manager GET, PATCH, DELETE Retrieve, update, and delete the user Managers can’t edit or delete other managers or admins
Admin GET, PATCH, DELETE Retrieve, update, and delete the user None

Usage:

curl -X GET localhost:8000/api/users/{userId} \
   -H "Content-Type: application/json" \
	 -H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/users/{userId} \
   -H "Content-Type: application/json" \
	 -H "Authorization: Bearer {token}"  \
   -d '{"email": "{email}"}'

curl -X DELETE localhost:8000/api/users/{userId} \
   -H "Content-Type: application/json" \
	 -H "Authorization: Bearer {token}"

Sign Up, Log In, and JWT Generation

/api/token/login/

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer POST Log in and get token authentication and token refresh None
Delivery Crew POST Log in and get token authentication and token refresh None
Manager POST Log in and get token authentication and token refresh None
Admin POST Log in and get token authentication and token refresh None

Usage:

curl -X POST localhost:8000/api/token/login/ \
   -H "Content-Type: application/json" \
   -d '{"username": "{username}", "password": "{password}"}'

/api/token/refresh/

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer POST Generate a new access token None
Delivery Crew POST Generate a new access token None
Manager POST Generate a new access token None
Admin POST Generate a new access token None

Usage:

curl -X POST localhost:8000/api/token/refresh/ \
   -H "Content-Type: application/json" \
   -d '{"refresh": "{refreshToken}"}'

/api/token/blacklist/

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager POST Blacklist the given refresh token Can’t blacklist refresh tokens that belongs to managers or admin
Admin POST Blacklist the given refresh token None

Usage:

curl -X POST localhost:8000/api/token/blacklist/ \
   -H "Content-Type: application/json" \
   -d '{"refresh": "{refreshToken}"}'

Groups

/api/groups

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager GET, POST Create and retrieve groups Can’t reach the Admin group
Admin GET, POST Create and retrieve groups None

Usage:

curl -X GET localhost:8000/api/groups \
   -H "Content-Type: application/json"\
   -H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/groups \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}" \
   -d '{"name": "{groupName}"}'

/api/groups/{groupId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager GET, PATCH, DELETE Retrieve, edit, and delete a group Can’t edit or delete Manager and Admin groups
Admin GET, PATCH, DELETE Retrieve, edit, and delete a group None

Usage:

curl -X GET localhost:8000/api/groups/{groupId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/groups/{groupId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"name": "{groupName}"}'

curl -X DELETE localhost:8000/api/groups/{groupId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

Group Customer

/api/groups/customers

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager GET, POST Retrieve the users in the group, add users to the group None
Admin GET, POST Retrieve the users in the group, add users to the group None

Usage:

curl -X GET localhost:8000/api/groups/customers \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/groups/customers \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"id": "{userId}"}'

Searching, ordering and filtering fields:

▶️ username, first_name, last_name

/api/groups/customers/{userId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager GET, PUT, PATCH, DELETE Retrieve, edit, and delete a user None
Admin GET, POST Retrieve, edit, and delete a user None

Usage:

curl -X GET localhost:8000/api/groups/customers/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/groups/customers/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"username": "{username}"}'

curl -X DELETE localhost:8000/api/groups/customers/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

Group Delivery Crew

/api/groups/delivery-crew

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager GET, POST Retrieve the users in the group, add users to the group None
Admin GET, POST Retrieve the users in the group, add users to the group None

Usage:

curl -X GET localhost:8000/api/groups/delivery-crew \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/groups/delivery-crew \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"id": "{userId}"}'

Searching, ordering and filtering fields:

▶️ username, first_name, last_name

/api/groups/delivery-crew/{userId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Delivery Crew GET, PATCH, DELETE Retrieve, edit, and delete a user A delivery crew can only reach its own user
Manager GET, PATCH, DELETE Retrieve, edit, and delete a user None
Admin GET, PATCH, DELETE Retrieve, edit, and delete a user None

Usage:

curl -X GET localhost:8000/api/groups/delivery-crew/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/groups/delivery-crew/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"username": "{username}"}'

curl -X DELETE localhost:8000/api/groups/delivery-crew/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

Group Manager

/api/groups/managers

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager GET, POST Retrieve the users in the group, add users to the group None
Admin GET, POST Retrieve the users in the group, add users to the group None

Usage:

curl -X GET localhost:8000/api/groups/managers \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/groups/managers \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"id": "{userId}"}'

Searching, ordering and filtering fields:

▶️ username, first_name, last_name

/api/groups/managers/{userId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Manager GET Retrieve user details None
Admin GET, PATCH, DELETE Retrieve, edit, and delete the user None

Usage:

curl -X GET localhost:8000/api/groups/managers/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/groups/managers/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"username": "{username}"}'

curl -X DELETE localhost:8000/api/groups/managers/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

Group Admin

/api/groups/admins

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Admin GET, POST Retrieve the users in the group, add users to the group None

Usage:

curl -X GET localhost:8000/api/groups/admins \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/groups/admins \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"id": "{userId}"}'

Searching, ordering and filtering fields:

▶️ username, first_name, last_name

/api/groups/admins/{userId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Admin GET, PUT, PATCH, DELETE Retrieve, edit, and delete the user None

Usage:

curl -X GET localhost:8000/api/groups/admins/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/groups/admins/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"username": "{username}"}'

curl -X DELETE localhost:8000/api/groups/admins/{userId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

Menu Items

/api/menu-items

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve the list of menu-items None
Delivery Crew GET Retrieve the list of menu-items None
Manager GET, POST Retrieve the list of menu-items, add new menu-items None
Admin GET, POST Retrieve the list of menu-items, add new menu-items None

Usage:

curl -X GET localhost:8000/api/menu-items \
   -H "Content-Type: application/json"    \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/menu-items \
   -H "Content-Type: application/json"     \
	-H "Authorization: Bearer {token}"      \
	-d '{"title": "{title}", "price": "{value}", "feature": "{value}", "category_id": "{id}"}'

Searching, ordering and filtering fields:

▶️ title, price, featured, category

The category query parameter accept both integer (for category ID) and string (for category title).

The feature query parameter accepts bool values such as 1, 0, True and False.

/api/menu-items/{menu-itemId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve menu-item details None
Delivery Crew GET Retrieve menu-item details None
Manager GET, PATCH, DELETE Retrieve, edit, and delete the menu-item None
Admin GET, PATCH, DELETE Retrieve, edit, and delete the menu-item None

Usage:

curl -X GET localhost:8000/api/menu-items/{menu-itemId} \
   -H "Content-Type: application/json"    \
	-H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/menu-items/{menu-itemId} \
   -H "Content-Type: application/json"     \
	-H "Authorization: Bearer {token}"      \
	-d '{"title": "{title}", "price": "{value}", "feature": "{value}", "category_id": "{id}"}'

curl -X DELETE localhost:8000/api/menu-items/{menu-itemId} \
   -H "Content-Type: application/json"    \
   -H "Authorization: Bearer {token}"

Categories

/api/categories

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve the list of categories None
Delivery Crew GET Retrieve the list of categories None
Manager GET, POST Retrieve the list of categories, add new categories None
Admin GET, POST Retrieve the list of categories, add new categories None

Usage:

curl -X GET localhost:8000/api/categories \
   -H "Content-Type: application/json"    \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/categories \
   -H "Content-Type: application/json"     \
	-H "Authorization: Bearer {token}"      \
	-d '{"title": "{title}", "slug": "{slug}"}'

Searching, ordering and filtering fields:

▶️ title, slug

/api/categories/{categoryId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve category details None
Delivery Crew GET Retrieve category details None
Manager GET, PATCH, DELETE Retrieve, edit, and delete the category None
Admin GET, PATCH, DELETE Retrieve, edit, and delete the category None

Usage:

curl -X GET localhost:8000/api/categories/{categoryId} \
   -H "Content-Type: application/json"                 \
   -H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/categories/{categoryId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}" \
	-d '{"title": "{title}", "slug": "{slug}"}'

curl -X DELETE localhost:8000/api/categories/{categoryId} \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

Menu Items Per Category

/api/categories/{categoryId}/menu-items

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve the list of menu-items associated with the category None
Delivery Crew GET Retrieve the list of menu-items associated with the category None
Manager GET Retrieve the list of menu-items, add new menu-items None
Admin GET Retrieve the list of menu-items, add new menu-items None

Usage:

curl -X GET localhost:8000/api/menu-items \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

Searching, ordering and filtering fields:

▶️ title, price, featured

The feature query parameter accepts bool values such as 1, 0, True and False.

Order Items

/api/order-items

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET, POST Retrieve users’ order-items, create a new order-item Other users’ order-items are unreachable
Manager GET, POST Retrieve users’ order-items, create a new order-item None
Admin GET, POST Retrieve users’ order-items, create a new order-item None

Note:

While creating an order-item the default user will be automatically set to the currently logged user. If a manager or and admin creates an order-item, they should edit it in order to change the user assigned to that order-item.

Usage:

curl -X GET localhost:8000/api/order-items \
   -H "Content-Type: application/json"     \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/order-items \
   -H "Content-Type: application/json"      \
	-H "Authorization: Bearer {token}"       \
   -d '{"id": "{menu-itemId}", "quantity": "{value}"}'

Searching, ordering, and filtering fields:

▶️ user, menu item

For both user and menu item, pass an integer (userId or menu-itemId) to look for.

/api/order-items/{order-itemId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET, PATCH, DELETE Retrieve, edit, and delete the order-item Other users’ order-items are unreachable
Manager GET, PATCH, DELETE Retrieve, edit, and delete the order-item None
Admin GET, PATCH, DELETE Retrieve, edit, and delete the order-item None

Usage:

curl -X GET localhost:8000/api/order-items/{order-itemId} \
   -H "Content-Type: application/json"     \
   -H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/order-items/{order-itemId} \
   -H "Content-Type: application/json"      \
	-H "Authorization: Bearer {token}"       \
   -d '{"quantity": "{menu-itemId}"}'

curl -X DELETE localhost:8000/api/order-items/{order-itemId} \
   -H "Content-Type: application/json"     \
   -H "Authorization: Bearer {token}"

Cart

/api/cart

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET, POST, DELETE Retrieve users’ cart, add order-items to the cart, delete order-items The cart of other users are unreachable

Usage:

curl -X GET localhost:8000/api/cart    \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/cart   \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {token}"  \
   -d '{"id": "{order-itemId}"}'

curl -X DELETE localhost:8000/api/cart \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"  \
   -d '{"id": "{order-itemId}"}'

curl -X DELETE localhost:8000/api/cart \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

A DELETE request requires the id of the order-item that should be deleted. If no id is provided, all the order-items in the cart will be deleted.

Orders

/api/orders

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET, POST Retrieve the list of orders, create new orders Other users’ orders are unreachable
Manager GET Retrieve the list of orders None
Admin GET Retrieve the list of orders None
Delivery Crew GET Retrieve the list of orders Members of this group can only reach those orders assigned to them.

Usage:

curl -X GET localhost:8000/api/orders  \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {token}"

curl -X POST localhost:8000/api/orders \
   -H "Content-Type: application/json" \
	-H "Authorization: Bearer {token}"

A POST request creates a new order with the order-items present in the user’s cart. This request creates purchase-items instances from the order-items, and adds them to a Purchase instance which will be added to an Order instance. The last step is to delete all the order-items from the cart.

This procedure ensures that a user doesn’t add repeated menu-items to the order-items giving its unique together (user, menu-item) constraint and, once the order has been created, deletes the order-item allowing the user to create new orders with the same menu-items.

Searching, ordering and filtering fields:

▶️ user, delivery_crew, status, date

For both user and delivery_crew, pass an integer (userId or delivery_crewId) to look for.

For status, pass a boolean value such as 1, 0, True, and False.

For date, pass a datetime sting such as 2023-02-16T19:36:15.043310Z

/api/orders/{orderId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve order details Other users’ orders are unreachable
Delivery Crew GET, PATCH Retrieve order details, change the status Members of this group can only reach those orders assigned to them.
Manager GET, PATCH, DELETE Retrieve, edit, and delete the order None
Admin GET, PATCH, DELETE Retrieve, edit, and delete the order None

Usage:

curl -X GET localhost:8000/api/orders/{orderId}  \
   -H "Content-Type: application/json"  \
   -H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/orders/{orderId} \
   -H "Content-Type: application/json"  \
   -H "Authorization: Bearer {token}"   \
   -d '{"status": "{value}"}'

curl -X DELETE localhost:8000/api/orders/{orderId}  \
   -H "Content-Type: application/json"  \
	-H "Authorization: Bearer {token}"

Allowed status values are 0 and 1, for True and False respectively.

Purchase

/api/purchases

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve purchases list Other users’ purchases are unreachable
Delivery Crew GET Retrieve purchases list Can only retrieve purchases related to orders assign to them
Manager GET Retrieve purchases list None
Admin GET Retrieve purchases list None

Usage:

curl -X GET localhost:8000/api/purchases \
   -H "Content-Type: application/json"   \
   -H "Authorization: Bearer {token}"

Searching, ordering and filtering fields:

▶️ user, date

For user pass an integer (userId) to look for.

For date, pass a DateTime string such as 2023-02-16T19:36:15.043310Z

/api/purchases/{purchaseId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve the purchase Other users’ purchases are unreachable
Delivery Crew GET Retrieve the purchase Can only retrieve purchases related to orders assign to them
Manager GET, DELETE Retrieve and delete the purchase None
Admin GET, DELETE Retrieve and delete the purchase None

Usage:

curl -X GET localhost:8000/api/purchases/{purchaseId} \
   -H "Content-Type: application/json"  \
	-H "Authorization: Bearer {token}"

curl -X DELETE localhost:8000/api/purchases/{purchaseId} \
   -H "Content-Type: application/json"  \
   -H "Authorization: Bearer {token}"

Purchase Items

/api/purchase-items

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve purchase-items lust Other users’ purchase-items are unreachable
Delivery Crew GET Retrieve purchase-items lust Can only retrieve purchase-items related to orders assign to them
Manager GET Retrieve purchase-items lust None
Admin GET Retrieve purchase-items lust None

Usage:

curl -X GET localhost:8000/api/purchases/{purchaseId} \
   -H "Content-Type: application/json"  \
	-H "Authorization: Bearer {token}"

curl -X DELETE localhost:8000/api/purchases/{purchaseId} \
   -H "Content-Type: application/json"  \
   -H "Authorization: Bearer {token}"

Searching, ordering, and filtering fields:

▶️ user, menuitem, price

For both user and menuitem, pass an integer (userId or menu-itemId) to look for.

/api/purchase-items/{purchase-itemId}

ROLE ALLOWED METHODS ACTIONS RESTRICTIONS WITHIN ALLOWED METHODS
Customer GET Retrieve the purchase-item Other users’ purchases are unreachable
Delivery Crew GET Retrieve the purchase-item Can only retrieve purchases related to orders assign to them
Manager GET, PATCH, DELETE Retrieve, edit, and delete the purchase-item None
Admin GET, PATCH, DELETE Retrieve, edit, and delete the purchase-item None

Usage:

curl -X GET localhost:8000/api/purchases/{purchaseId} \
   -H "Content-Type: application/json"  \
	-H "Authorization: Bearer {token}"

curl -X PATCH localhost:8000/api/purchases/{purchaseId} \
   -H "Content-Type: application/json"  \
   -H "Authorization: Bearer {token}"   \
   -d '{"quantity": "{value}"}'

curl -X DELETE localhost:8000/api/purchases/{purchaseId} \
   -H "Content-Type: application/json"  \
	-H "Authorization: Bearer {token}"

littlelemon-api's People

Contributors

adolfojmnz avatar

Stargazers

Pirashanth avatar avatar Knut Edvard Kjersem avatar Muskan Matwani avatar Antonio Cascella avatar Muhammad Hamad khan avatar Alexandre Gallego Mato avatar avatar M Bilal Naeem avatar Quinn Le avatar AhSuro93 avatar avatar ~ATDG~ avatar Lea Wang Yi avatar

Watchers

avatar

Forkers

98atanu johnsongith bilal-251 matpakke silverviles soumya1999rta swetsagar buffalo-bbb shanth05

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.