Skip to content

Latest commit

 

History

History
256 lines (196 loc) · 3.58 KB

ENDPOINTS.md

File metadata and controls

256 lines (196 loc) · 3.58 KB

Endpoints

✦ User Endpoints

POST Sign Up

Path: /user/signup

Body:

{
    "name": "Dua Lipa",
    "email": "[email protected]",
    "password": "rulebreaker"
}

POST Login

Path: /user/login

Body:

{
    "email": "[email protected]",
    "password": "foraelon"
}

POST Follow User

Path: /user/follow

Headers

authorization: "token"

Body:

{
    "userToFollowId": "7d49a150-6b37-4cb7-a648-616a5f14b78e"
}

POST Unfollow User

Path: /user/unfollow

Headers

authorization: "token"

Body:

{
    "userToUnfollowId": "7d49a150-6b37-4cb7-a648-616a5f14b78e"
}

POST Reset Password

Path: /user/password/reset

Body:

{
    "email": "[email protected]"
}

Response:

{
    "message": "Password updated. Please check your email"
}

GET All Users

Path: /users/all

Headers

authorization: "token"

Response:

{
    "users": [
        {
            "id": "360e9dd3-7ce4-4922-a247-0a2dd3520175",
            "name": "Ariana Grande"
        },
        {
            "id": "72408ceb-f3d4-43e1-b78e-fbd5b12fedbe",
            "name": "Lorde"
        },
        {
            "id": "7d49a150-6b37-4cb7-a648-616a5f14b78e",
            "name": "Dua Lipa"
        },
        {
            "id": "94d8e292-8b2a-41f1-9577-a7436897c836",
            "name": "Taylor Swift"
        },
        {
            "id": "df6e79ef-186f-439e-8263-03958ec96b2b",
            "name": "Grimes"
        }
    ]
}

GET Own Profile

Path: /user/profile

Headers

authorization: "token"

Response:

{
    "user": {
        "id": "72408ceb-f3d4-43e1-b78e-fbd5b12fedbe",
        "name": "Lorde",
        "email": "[email protected]"
    }
}

GET User Profile

Path: /user/:id

Headers

authorization: "token"

Path Param: user id

Response:

{
    "user": {
        "id": "94d8e292-8b2a-41f1-9577-a7436897c836",
        "name": "Taylor Swift",
        "email": "[email protected]"
    }
}

DELETE User (admin only!)

Path: /user/:id

Headers

authorization: "token"

Path Param: user id

Response:

{
    "message": "User deleted"
}

✦ Recipe Endpoints

POST Create Recipe

Path: /recipe/create

Body:

{
	"title": "Ovo Frito",
	"description": "Pega o ovo, põe na frigideira e reza!"
}

GET All Recipes

Path: /recipe/all

Headers

authorization: "token"

Response:

{
    "recipes": [
        {
            "id": "bde81465-bcab-4a06-a6bc-48098db86a0d",
            "title": "Pure de Batata",
            "description": "Pega umas batatas, cozinha, amassa, adiciona sal e tá pronto!"
        },
        {
            "id": "e9a4bcd4-5a21-4faf-a895-501133fd7f5e",
            "title": "Ovo Frito",
            "description": "Pega o ovo, põe na frigideira e reza!"
        }
    ]
}

GET Recipe By Id

Path: /recipe/:id

Headers

authorization: "token"

Path Param: id da receita

Response:

{
    "recipe": {
        "id": "bde81465-bcab-4a06-a6bc-48098db86a0d",
        "title": "Pure de Batata",
        "description": "Pega umas batatas, cozinha, amassa, adiciona sal e tá pronto!",
        "createdAt": "29/01/2021",
        "creatorId": "df6e79ef-186f-439e-8263-03958ec96b2b",
        "creatorName": "Grimes"
    }
}