Build-Week-Restaurant-Passport-5 / backend

A REST API that allows customers to create an account and manage their restaurants.

Restaurant Passport

A home for all your foodie aspirations.

Navigation:

• Auth Endpoints

  • Register
  • Login

• Restaurant Endpoints

• Status Codes

• Content Info

API Documentation

Auth Endpoints

Table	Method	Endpoint	Description
users_table	POST	/api/auth/register	Registers a new user.
users_table	POST	/api/auth/login	Logs in already registered user.

Register

Request Body

Name	Type	Required	Description
username	String	Yes	Must be Unique.
password	String	Yes
name	String	Yes
city	String	Yes
email	String	Yes

Example:

    {
         username: "love2eat19",
         password: "json245",
         name: "Ipsum",
         city: "Lorem",
         email: "[e-mail]"
        }

Login

Request Body

Name	Type	Required
username	String	Yes
password	String	Yes

Example:

    {
         username: "love2eat19",
         password: "json245"
        }

---

Restaurant Endpoints

Table	Method	Endpoint	Description
restaurants_table	GET	/api/restaurants	Gets list of restaurants
restaurants_table	GET	/api/restaurants/:id	Restaurant by ID.
restaurants_table	POST	/api/restaurants/:id	Create a new entry for the specific user that is logged in. (i.e. for an id of 2, would post to user 2)
restaurants_table	PUT	/api/restaurants/:id	Edit an existing entry
restaurants_table	DELETE	/api/restaurants/:id	Delete an entry

Request Body

Name	Type	Required	Description
restaurantName	String	Yes
streetAddress	String	No
city	String	No
zipcode	String	No
phoneNumber	String	No
websiteURL	String	No
myRating	Integer	No	1-5
notes	String	No
stamped	Boolean	Yes	Default: false

Example:

       {
        restaurantName: "Pappadeaux",
        streetAddress: "34455 N Black Canyon Hwy",
        city: "Tuscon",
        zipcode: "00000",
        phoneNumber: "[phone]",
        websiteURL: "http://yumyumyum.com",
        myRating: "5",
        notes: "Good food.",
        stamped: true,
       }

---

Status Codes

Status	Meaning	Description
200	OK	request has succeeded
201	Created	The request has been fulfilled and has resulted in one or more new resources being created.
401	Unauthorized	the page you were trying to access cannot be loaded until you first log in with a valid user ID and password.
500	Internal Server Error	something has gone wrong on the web site's server

---

Content

• Content-Type: application/JSON

• Authorization: JSON Web Token