african-marketplace's Introduction

African Marketplace

Delpoyed URL: https://lbs-african-marketplace.herokuapp.com

Models

users

{
	id: integer
	username: string
	password: string
	department: string,  must be "seller" or "buyer"
}

items

{
	id: integer
	name: text
	description: text
	price: float
	location: text
	category: text
	URL: string
	user_id: integer, references the id of the user the item is referenced to
}

End Points

Auth Routes

Method	Endpoint	Token Required	Description
POST	`/auth/register`	no	Registers a new user Required: username, password, and department. Returns id, username, and department.
POST	`/auth/login`	no	Signs in user and returns a token. Required: username and password. Returns a token.

User Routes

Method	Endpoint	Token Required	Description
GET	`/users`	yes	Returns all users
GET	`/users/:id`	yes	Returns a single user by id
GET	`/users/:id/items`	yes	Returns a single user's items
DELETE	`/users/:id/`	yes	Deletes a single user

Items Routes

Method	Endpoint	Token Required	Description
GET	`/items`	yes	Returns all items
GET	`/items/:id`	yes	Returns a single item
POST	`/items/additem`	yes	Adds an item to the database Required: `user_id` All other values in the model are optional, but encouraged.
PUT	`/items/:id`	yes	Edits a single item
DELETE	`/items/:id`	yes	Deletes a single item
GET	`/items/:category`	yes	Gets all items in a category

Recommend Projects