Natours is a simple tour API and server side rendered website! Built to learn backend web development!
- Nodejs
- Express.js
- MongoDB
- Mongoose
- Pug.js
Natours is an API built organize tour information in a NoSQL database with advanced authentication and authorization involving multiple user roles. Server side rendered website to access API Features is available!
- Filtering, sorting, limiting fields and pagination all implemented on any endpoint that returns multiple objects!
Get all tours stored in the database
GET /api/v1/toursAUTHORIZATION REQUIRED
admin or lead guide
Create a new tour sending the data in JSON form
POST /api/v1/toursGet a certain tour
GET /api/v1/tours/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the tour in the database |
AUTHORIZATION REQUIRED
admin or lead guide
Update and existing tour sending the data in JSON form
PATCH /api/v1/tours/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the tour in the database |
AUTHORIZATION REQUIRED
admin or lead guide
Delete an already existing tour
DELETE /api/v1/tours/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the tour in the database |
Get the top 5 cheapest tours
GET /api/v1/top-5-cheapGet tours stats broken into difficulties
GET /api/v1/top-5-cheapAUTHORIZATION REQUIRED
admin, lead guide or guide
Get monthly stats based on a specific year
GET /api/v1/tours/monthly-plan/:year| Parameter | Type | Description |
|---|---|---|
year |
number |
Required. Year to get stats on |
GET /tours-within/:distance/center/:latlng/unit/:unit| Parameter | Type | Description |
|---|---|---|
distance |
number |
Required. Max distance from point |
latlng |
number |
Required. Longitude and latitude to specify the point |
unit |
string |
Required. Kilometers or miles |
Get distances to all tours from a point
GET /api/v1/tours/distances/:latlng/unit/:unit| Parameter | Type | Description |
|---|---|---|
latlng |
number |
Required. Longitude and latitude to specify the point |
unit |
string |
Required. Kilometers or miles |
AUTHORIZATION REQUIRED
admin
Get all user stored in the database
GET /api/v1/usersAUTHORIZATION REQUIRED
admin
Create a new user sending the data in JSON form
POST /api/v1/usersAUTHORIZATION REQUIRED
admin
Get a certain user
GET /api/v1/users/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the user in the database |
AUTHORIZATION REQUIRED
admin
Update and existing tour sending the data in JSON form
PATCH /api/v1/users/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the user in the database |
AUTHORIZATION REQUIRED
admin
Delete an already existing user
DELETE /api/v1/users/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the user in the database |
AUTHORIZATION REQUIRED
admin, lead guide, guide or user
Get the currently logged user
GET /api/v1/users/meAUTHORIZATION REQUIRED
admin, lead guide, guide or user
Update the currently logged user's information
PATCH /api/v1/users/meAUTHORIZATION REQUIRED
admin, lead guide, guide or user
Delete the currently logged user
DELETE /api/v1/users/meSign up sending the user information in JSON format
POST /api/v1/users/loginLog in sending the user information in JSON format
POST /api/v1/users/loginSend a forgot your password email to obtain the user's token
POST /api/v1/users/forgot-passwordReset the user password using the reset token
PATCH /api/v1/users/reset-password/:token| Parameter | Type | Description |
|---|---|---|
token |
string |
Required. Password reset token |
AUTHORIZATION REQUIRED
admin, lead guide, guide or user
Update current logged in user's password
PATCH /api/v1/users/update-passwordSend the verification email to the user
POST /api/v1/users/send-verification-emailVerify user's email using token
POST /api/v1/users/verify-email/:token| Parameter | Type | Description |
|---|---|---|
token |
string |
Required. Email verification token |
Get all reviews stored in the database
GET /api/v1/reviewsAUTHORIZATION REQUIRED
user
Create a new review sending the data in JSON form
POST /api/v1/reviewsGet a certain review
GET /api/v1/reviews/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the review in the database |
AUTHORIZATION REQUIRED
admin or user
Update and existing review sending the data in JSON form
PATCH /api/v1/reviews/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the review in the database |
AUTHORIZATION REQUIRED
admin or user
Delete an already existing review
DELETE /api/v1/reviews/:id| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. ID of the review in the database |