Skip to content

Commit 7b08461

Browse files
Update formatting in README
1 parent 65bd805 commit 7b08461

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,17 @@
33
[![Tests](https://github.com/piyush-jaiswal/ecommerce-rest-api/actions/workflows/tests.yml/badge.svg)](https://github.com/piyush-jaiswal/ecommerce-rest-api/actions/workflows/tests.yml)
44

55
RESTful HTTP API using Python Flask that allows users to manage their ecommerce platform.
6-
<br></br>
6+
<br>
77

88
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.
99
<br></br>
1010
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.
1111
<br></br>
1212
Paginates result when products are fetched by categories or subcategories.
1313

14-
<br>
15-
<br>
16-
1714
Deployed as a vercel function with Postgres: [ecommerce-rest-api-five.vercel.app](https://ecommerce-rest-api-five.vercel.app)
1815
<br> Documented with Swagger UI.
19-
20-
<br/>
16+
<br><br>
2117

2218
### Requirements
2319
This project is written in `Python 3.12.1`
@@ -71,14 +67,14 @@ Test the API using Swagger UI (`/` route), Postman, cURL or your preferred HTTP
7167
- [GET] `/category/<category_id: int>/products` - Get product with within category `category`. Returns first page of the paginated results. <br/><br/>
7268
- [GET] `/category/<category_id: int>/products?page=<page_no>` - Get product with within category `category`. Returns `page_no` of the paginated results. <br/><br/>
7369

74-
<br/>
7570

7671
#### Authorization
7772
``Protected`` endpoints require the following header:
7873
`Authorization: Bearer <access_token>`
7974

8075
``Refresh protected`` endpoints requires the following header:
8176
`Authorization: Bearer <refresh_token>`
77+
<br><br>
8278

8379
#### Authentication
8480
- [POST] `/auth/register` - Register a new user.

0 commit comments

Comments
 (0)