Skip to content

Latest commit

 

History

History
111 lines (78 loc) · 3.43 KB

README.md

File metadata and controls

111 lines (78 loc) · 3.43 KB
Raw

Dtravel REST API

About:

This REST API was built during DCI's WEB Development Course, which We attended between 2019 - 2021.

This API is beeing used for the Dtravel Client

Endpoints

/api/v1/places

Method Desc Endpoint
GET Get all the places /api/v1/places
GET Get an unique place /api/v1/places/id
PATCH Update an unique place /api/v1/places/id
DELETE Delete an unique place /api/v1/places/id
POST Create an unique place /api/v1/places

Creating an new Place using Postman

localhost:8000/api/v1/places

JSON Body

{
    "productName": "phuket",
    "description": "Located in southern Thailand, Phuket offers something for everyone, especially budget-minded travelers. Everything from accommodations to spa treatments to boat tours come with a low price tag. For stunning scenery, check out the limestone cliffs of Phang Nga Bay and lounge on Phuket's gorgeous white sand beaches. Other must-sees include Wat Chalong Temple and the Big Buddha. Once the sun sets, take part in the island's lively nightlife scene.",
    "country": "thailand",
    "continent": "asia",
    "type": "tropical",
    "difficulty": "medium",
    "price": 3000,
    "cover": {
      "url": "phuket/mike-swigunski.jpg",
      "description": "Maui is an island in the Central Pacific, part of the Hawaiian archipelago."
    },
    "imgs": [
      {
        "url": "phuket/william-rouseh.jpg",
        "description": "phuket Image 1 - Put some description"
      },
      {
        "url": "phuket/frankie-spontell.jpg",
        "description": "phuket Image 2 - Put some description"
      },
      {
        "url": "phuket/vitaly-sacred.jpg",
        "description": "Maui Image 3 - Put some description"
      }
    ]
  }

/api/v1/users

Method Desc Endpoint
POST Signup with a User /api/v1/users/signup

Creating a new user using Postman

localhost:8000/api/v1/users/signup

JSON Body

    {
    "name": "Claudinei Bido",
    "email": "[email protected]",
    "password": "mypassword",
    "passwordConfirm": "mypassword"
}

Filters

Pagination

/api/v1/places?page=1&limit=5

Available Scripts

In the project directory, you can run:

yarn install

Install all the required packages.

yarn start:dev

Runs the app in the development mode.
Open http://localhost:8000 to view it in the browser.

yarn start:production

Start the API in production mode, all the loggers will be disabled

yarn debug

Start the API in debugger mode using ndb debugger

🚀 Technologies used

Contact

Created by Claudinei Bido - feel free to contact me!