Skip to content

artportfolio/Back-End-Architect

BranchesTags

Repository files navigation

Back-End-Architect

Brooks Poltl

Live Backend URL: https://backend-art.herokuapp.com/

Register a user

method url: /api/register

http method: [POST]

Headers

name type required description
Content-Type String Yes Must be application/json

Body

name type required description
username String Yes Must be unique
fullName String Yes
password String Yes
email String No
userImgUrl String No

Example

  {
    "username": "brooks",
    "password": "1234",
    "fullName": "Brooks Poltl",
    "email": "[email protected]",
    "userImgUrl": "something.jpg"
  }

Response

201 (created)
Example Response
  {
    "id": 1
    "username": "brooks",
    "password": "1234",
    "fullName": "Brooks Poltl",
    "email": "[email protected]",
    "userImgUrl": "something.jpg"
  }
400 (Bad Request)
  {
    "errorMessage": "missing ${itemMissing}"
  }

Login a user

method url: /api/login

http method: [POST]

Headers

name type required description
Content-Type String Yes Must be application/json

Body

name type required description
username String Yes must be registered user
password String Yes

Example

  {
    "username": "brooks",
    "password": "1234",
  }

Response

200 (ok)

no issues logging in

Example response
{
    "id":3,
    "username":"brooks",
    "fullName":"Brooks Poltl",
    "email":null,
    "userImgUrl":null,
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2Vybmk"
}
400 (Bad Request)
  {
    errorMessage: 'missing ${itemMissing}'
  }
401 (Unauthorized)
{
  errorMessage: "passwords don't match"
}

get all users

method url: /api/users

http method: [GET]

Response

200 (ok)
Example response
[
  {
     "id": 1,
     "username": "brooks3",
     "password": "$2a$12$UzYfINUnqfZh2n180pBswORvPCIrwHKp3d/MEZ69DaRxoLTYj26UG",
     "fullName": "Brooks Poltl",
     "email": null,
     "userImgUrl": null
  },
  {
     "id": 2,
     "username": "Bob",
     "password": "$2a$12$5.flIIREO8kVSwAGdL2iWO1IUKaaN7VgKN9zEX/Z7XXygBupMSQ0W",
     "fullName": "McBobbers",
     "email": "[email protected]",
     "userImgUrl": ""
  },
  {
    "id": 3,
    "username": "spencer",
    "password": "$2a$12$5F3zLBEigPgcTQxzQFT23.hW3A15PDyelLAFU.ENtym5Jdn17ypjW",
    "fullName": "Spencer Curtis",
    "email": null,
    "userImgUrl": null
  },
]

get a single user

method url: /api/users/:id

http method: [GET]

Response

200 (ok)
Example response
[
  {
    "id": 1,
    "username": "brooks3",
    "password": "$2a$12$UzYfINUnqfZh2n180pBswORvPCIrwHKp3d/MEZ69DaRxoLTYj26UG",
    "fullName": "Brooks Poltl",
    "email": null,
    "userImgUrl": null
  }
]

get a user profile with all post

method url: /api/users/posts/:id (id meaning id of the user)

http method: [GET]

Response

200 (ok)
Example response
[
  {
    "id": 6,
    "username": "brooks12345",
    "password": "$2a$12$xEMuC6KExFMmz95p6jIAoe4CYT1oDPGBPHpxjR4FjIMmUGO09iR.m",
    "fullName": "hasdjhkha",
    "email": null,
    "userImgUrl": null,
    "posts": [
        {
          "id": 11,
          "imageUrl": "insertedImgurl",
          "upvotes": 0,
          "userId": 6,
          "description": "a painting :)",
          "postName": "mona lisa"
        },
        {
          "id": 12,
          "imageUrl": "insertedImgurl",
          "upvotes": 0,
          "userId": 6,
          "description": "a painting :)"
          "postName": "mona lisa"
        },
        {
          "id": 13,
          "imageUrl": "insertedImgurl",
          "upvotes": 0,
          "userId": 6,
          "description": "a painting :)",
          "postName": "mona lisa"
        },
        {
          "id": 14,
          "imageUrl": "insertedImgurl",
          "upvotes": 0,
          "userId": 6,
          "description": "a painting :)",
          "postName": "starry night"
         }
        ]
    }
]

Edit a User Account

method url: /api/users/:id

http method: [PUT]

Headers

name type required description
Content-Type String Yes Must be application/json
authorization String Yes token to Authorize user

Body

name type required description
username String No Must be unique
fullName String No
password String No
email String No
userImgUrl String No

Example

  {
    "username": "brookspoltl",
    "password": "hunter2",
    "fullName": "Brooks Poltl",
  }

Response

200 (ok)
Example Response
  {
    "message":"your account has been edited"
  }
401 (Unauthorized)
Example Response
  {
    "errorMessage": "you are not authorized to edit this account"
  }
403 (Forbidden)
Example Response
  {
    "message": "invalid token"
  }

Delete an Account

method url: /api/users/:id

http method: [DELETE]

Headers

name type required description
Content-Type String Yes Must be application/json
authorization String Yes token to Authorize user

Response

200 (ok)
Example Response
  {
    "message":"your account has been deleted"
  }
401 (Unauthorized)
Example Response
  {
    "errorMessage": "you are not authorized to delete this account"
  }
403 (Forbidden)
Example Response
  {
    "message": "invalid token"
  }

create a Post

method url: /api/posts

http method: [POST]

Headers

name type required description
Content-Type String Yes Must be application/json
authorization String Yes token to Authorize user

Body

name type required description
postName String Yes
imageUrl String Yes
description String No

Example

  {
    "postName": "Mona Lisa",
    "imageUrl": "monaLisa.jpg",
    "description": "cool painting i made",
  }

Response

201 (created)
Example Response
  {
    "id": 1,
    "postName": "Mona Lisa",
    "imageUrl": "monaLisa.jpg",
    "description": "cool painting i made",
    "upvotes": 0,
    "userId": 3
  }
401 (Unauthorized)
Example Response
  {
    "message": "no token"
  }
403 (Forbidden)
Example Response
  {
    "message": "invalid token"
  }

get all posts

method url: /api/posts

http method: [GET]

Response

200 (ok)
Example response
[
 {
    "id": 12,
    "imageUrl": "insertedImgurl",
    "upvotes": 0,
    "userId": 6,
    "description": "a painting :)",
    "postName": "mona lisa"
 },
 {
    "id": 13,
    "imageUrl": "insertedImgurl",
    "upvotes": 0,
    "userId": 6,
    "description": "a painting :)",
    "postName": "mona lisa"
  },
  {
    "id": 14,
    "imageUrl": "insertedImgurl",
    "upvotes": 0,
    "userId": 6,
    "description": "a painting :)",
    "postName": "starry night"
  }
]

get a single post

method url: /api/posts/:id (as in id of the post)

http method: [GET]

Response

200 (ok)
Example response
{
    "id": 14,
    "imageUrl": "insertedImgurl",
    "upvotes": 0,
    "userId": 6,
    "description": "a painting :)",
    "postName": "starry night"
}

get All posts from user, without user info

method url: /api/posts/users/:id (id meaning id of the user)

http method: [GET]

Response

200 (ok)
Example response
[
  {
        "id": 11,
        "imageUrl": "insertedImgurl",
        "upvotes": 0,
        "userId": 6,
        "description": "a painting :)",
        "postName": "mona lisa"
    },
    {
        "id": 12,
        "imageUrl": "insertedImgurl",
        "upvotes": 0,
        "userId": 6,
        "description": "a painting :)",
        "postName": "mona lisa"
    },
    {
        "id": 13,
        "imageUrl": "insertedImgurl",
        "upvotes": 0,
        "userId": 6,
        "description": "a painting :)",
        "postName": "mona lisa"
    },
    {
        "id": 14,
        "imageUrl": "insertedImgurl",
        "upvotes": 0,
        "userId": 6,
        "description": "a painting :)",
        "postName": "starry night"
    }

]

Upvote a Post

method url: /api/posts/upvote/:id (id of the post)

http method: [PUT]

Response

200 (ok)
Example Response
  {
    "upvotes": 6
  }

Edit a Post

method url: /api/posts/:id

http method: [PUT]

Headers

name type required description
Content-Type String Yes Must be application/json
authorization String Yes token to Authorize user

Body

name type required description
postName String No
imageUrl String No
description String No

Example

  {
    "postName": "my masterpiece",
    "imageUrl": "hunter2.jpg",
  }

Response

200 (ok)
Example Response
  {
    "message":"your post has been edited"
  }
401 (Unauthorized)
Example Response
  {
    "errorMessage": "not authorized to edit this post"
  }
403 (Forbidden)
Example Response
  {
    "message": "invalid token"
  }

Delete a Post

method url: /api/posts/:id (id of the post)

http method: [DELETE]

Headers

name type required description
Content-Type String Yes Must be application/json
authorization String Yes token to Authorize user

Response

200 (ok)
Example Response
  {
    "message":"post successfully deleted"
  }
401 (Unauthorized)
Example Response
  {
    "errorMessage": "you are not authorized to delete this post"
  }
403 (Forbidden)
Example Response
  {
    "message": "invalid token"
  }

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages