Skip to content

Commit 40f9968

Browse files
authored
Update README.md
1 parent b1ff7f4 commit 40f9968

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Free Open source REST API built with | Nodejs + Express + Mongodb ⚡️ Made w
1515
- [Support](#Support)
1616
- [Feedback](#Feedback)
1717
- [Run Locally](#Run_Locally)
18-
- [Deployment](#API_Reference)
18+
- [API Reference](#API_Reference)
1919
- [Screenshots](#Screenshots)
2020
- [Environment Variables](#Environment)
2121
- [Deployment](#Deployment)
@@ -91,10 +91,12 @@ Free Open source REST API built with | Nodejs + Express + Mongodb ⚡️ Made w
9191
| `OrderBy` | `string` | default= desc |
9292
| `OrderBy` | `string` | default= desc |
9393

94-
##### example (Paginate - Sort - Filter - Full-text search
95-
> GET https://saddam-rest-api.herokuapp.com/api/v1/products?page=1&limit=99&sortBy=createdAt&OrderBy=desc&filterBy=category&category=Sports
96-
> GET https://saddam-rest-api.herokuapp.com/api/v1/products?page=2&limit=99&sortBy=createdAt&OrderBy=desc&filterBy=category&category=Jewelery
97-
> GET https://saddam-rest-api.herokuapp.com/api/v1/products?page=2&limit=99&sortBy=createdAt&OrderBy=desc&filterBy=category&category=Books&search=nodejs
94+
#### example (Paginate - Sort - Filter - Full-text search
95+
```http
96+
GET https://saddam-rest-api.herokuapp.com/api/v1/products?page=1&limit=99&sortBy=createdAt&OrderBy=desc&filterBy=category&category=Sports
97+
GET https://saddam-rest-api.herokuapp.com/api/v1/products?page=2&limit=99&sortBy=createdAt&OrderBy=desc&filterBy=category&category=Jewelery
98+
GET https://saddam-rest-api.herokuapp.com/api/v1/products?page=2&limit=99&sortBy=createdAt&OrderBy=desc&filterBy=category&category=Books&search=nodejs
99+
```
98100

99101
#### Get product
100102

@@ -109,7 +111,6 @@ Free Open source REST API built with | Nodejs + Express + Mongodb ⚡️ Made w
109111

110112

111113

112-
113114
# Environment
114115
- To run this project, you will need to add the following environment variables to your .env file (check environment.config.js file for more examples)
115116

0 commit comments

Comments
 (0)