Skip to content

Commit 408f58e

Browse files
add swagger info in README
1 parent 87ae39e commit 408f58e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Paginates result when products are fetched by categories or subcategories.
1010
<br/>
1111

1212
Deployed as a vercel function: [ecommerce-rest-api-five.vercel.app](https://ecommerce-rest-api-five.vercel.app)
13+
<br> Documented with Swagger UI.
1314

1415
### Requirements
1516
This project is written in `Python 3.12.1`
@@ -37,7 +38,7 @@ Start the server: (Runs on 127.0.0.1:5000)
3738
flask --app app run [--debug]
3839
```
3940

40-
Test the API using Postman, cURL or your preferred HTTP client.
41+
Test the API using Swagger UI (`/` route), Postman, cURL or your preferred HTTP client.
4142

4243
### Endpoints
4344

0 commit comments

Comments
 (0)