Starting the server locally
git clone [email protected]:tednaphil/stardew-api.git
cd stardew-api
node server.js
Server will run at http://localhost:3000
Deployed API link https://stardew-api.onrender.com
| Method | Endpoint | Request Body | Sample Response |
|---|---|---|---|
GET |
'/api/v1/characters' |
n/a | [{id: "1", name: "Abigail", hobbies: ["playing flute", "mining", "playing video games"], avatar: "URL"}] |
GET |
'/api/v1/characters/:id' |
n/a | {id: "1", name: "Abigail", hobbies: ["playing flute", "mining", "playing video games"], avatar: "URL"} |
PUT |
'/api/v1/characters/:id' |
{hobby: "shopping", avatar: "newURL"} |
{id: "1", name: "Abigail", hobbies: ["playing flute", "mining", "playing video games, shopping"], avatar: "newURL"} |
POST |
'/api/v1/characters' |
{name: "Ellis", hobbies: ["hobby1", "hobby2"], avatar: "URL"} |
{id: "2", name: "Ellis", hobbies: ["hobby1", "hobby2"], avatar: "URL"} |
DELETE |
'/api/v1/characters/:id' |
n/a | n/a |
- POST requests only require a
nameparameter. Default values will be assigned to hobbies and/or avatar. - PUT requests only require a hobby OR an avatar. Both are not required