Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/german-zarate/ecommerce-rest-api
RESTful API for an ecommerce website with categories, subcategories and products using flask.
https://github.com/german-zarate/ecommerce-rest-api
ecommerce-api flask python rest-api restful-api sqlalchemy sqlite
Last synced: 4 days ago
JSON representation
RESTful API for an ecommerce website with categories, subcategories and products using flask.
- Host: GitHub
- URL: https://github.com/german-zarate/ecommerce-rest-api
- Owner: german-zarate
- Created: 2024-05-14T13:54:06.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-05-14T13:54:34.000Z (9 months ago)
- Last Synced: 2024-12-05T15:12:05.340Z (2 months ago)
- Topics: ecommerce-api, flask, python, rest-api, restful-api, sqlalchemy, sqlite
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ecommerce REST API
RESTful HTTP API using Python Flask that allows users to manage their ecommerce platform.
Ability to create, read, update, and delete products, categories and subcategories. A category can have multiple subcategories and a subcategory can belong to multiple categories. Products can belong to multiple categories and subcategories.
Fetching a product fetches the details of categories and subcategories it belongs to. Provides the ability to search for products by name, category and subcategories.
Paginates result when products are fetched by categories or subcategories.
### Requirements
```bash
pip install -r requirements.txt
```
### Usage
Start the server:
`python app.py` (Starts the server on 127.0.0.1:5000)
This project is preloaded with a dummy `sqlite` database located in the `instance` directory. To start from a scratch db, delete the `instance` directory and start the server.
To test the API using Postman, install postman agent in your OS and call the API using Postman.
### Endpoints
#### Fetch products using name, category, subcategory
- [GET] `/product/` - Get product with name: `name`
- [GET] `/subcategory//products` - Get product with within subcategory `subcategory`. Returns first page of the paginated results.
- [GET] `/subcategory//products?page=` - Get product with within subcategory `subcategory`. Returns `page_no` of the paginated results.
- [GET] `/category//products` - Get product with within category `category`. Returns first page of the paginated results.
- [GET] `/category//products?page=` - Get product with within category `category`. Returns `page_no` of the paginated results.
#### Category
- [GET] `/categories` - Get all categories
- [GET] `/category/(int: category_id)` - Get category with category_id
- [DELETE] `/category/(int: category_id)` - Delete category with category_id
- [POST] `/category/create` - Create a new category
```
{
"name": "name",
"subcategories": [] //optional
}
```
- [PUT] `/category/(int: category_id)/update` - Update category with category_id
```
{
"name": "name",
"subcategories": [] //optional
}
```
#### Subcategory
- [GET] `/subcategories` - Get all subcategories
- [GET] `/subcategory/(int: subcategory_id)` - Get subcategory with subcategory_id
- [DELETE] `/subcategory/(int: subcategory_id)` - Delete subcategory with subcategory_id
- [POST] `/subcategory/create` - Create a new subcategory
```
{
"name": "name",
"categories": [(category ids)] //optional
"products": [] // optional
}
```
- [PUT] `/subcategory/(int: subcategory_id)/update` - Update subcategory with subcategory_id
```
{
"name": "name",
"categories": [] //optional
"products": [] // optional
}
```
#### Product
- [GET] `/products` - Get all products
- [GET] `/product/(int: product_id)` - Get product with product_id
- [DELETE] `/product/(int: product_id)` - Delete product with product_id
- [POST] `/product/create` - Create a new product
```
{
"name": "name",
"description": "description",
"subcategories": [] //optional
}
```
- [PUT] `/product/(int: product_id)/update` - Update product with product_id
```
{
"name": "name",
"description": "description",
"subcategories": [] //optional
}
```