Recipe 101

server test

GET https://server.recipe101.net/

This endpoint allows you to get free cakes.

200 Cake successfully retrieved.

"server running"

400 Could not find a cake matching this query.

"warning"

signout

GET https://server.recipe101.net/signout

200

{
    message:"ok"
}

400

"fail"

get recipe info

GET https://server.recipe101.net/recipe/:id

Path Parameters

Name	Type	Description
:id	integer	food_id

200

{
    data: {
        food_info: {
            id,
            userName,
            foodName,
            summary,
            nation,
            type,
            cookingTime,
            calorie,
            qnt,
            level,
            imgUrl,
            createdAt,
            updatedAt,
        },
        Ingredients: [
            {
                name,
                type,
                cap
            },
            ...
        ],
        Recipes: [
            {
                cookingNo,
                cookingDc,
                stepImage,
                stepTip
            },
            ...
        ],
        Comment:[
            {
                
            },
            ...
        ]
    },
    message: "ok"
}

400

"fail"

get userinfo

GET https://server.recipe101.net/user

Headers

Name	Type	Description
authorization	string	access token

200

{
    data: {
        userinfo: { userName, email, phone, userImage, createdAt },
     },
      meassge: "ok",
}

400

"fail"

401

"Unauthorized"

get subscribed users

GET https://server.recipe101.net/subscribe/:username

Path Parameters

Name	Type	Description
:username	string	username

Headers

Name	Type	Description
authorization	string	access token

200

{
    users:[
        "name1",
        "name2", 
        ...
        ]
    meassge:"ok"
}

400

"fail"

401

"Unauthorized"

get stored recipes

GET https://server.recipe101.net/store

Headers

Name	Type	Description
authorization	string	access token

200

{ 
    data:[
        {
            id,
            foodName,
            imgUrl,
            level,
            cookingTime,
            score
        },
        {
            id,
            foodName,
            imgUrl,
            level,
            cookingTime,
            score
        },
        ....
    ],  
    message: "0k" 
}

400

"fail"

401

"Unauthorized"

get comment by username

GET https://server.recipe101.net/comment/user/:username

Path Parameters

Name	Type	Description
:username	string	username

200

{
    data:[
            {
                    id,
                    foodName,
                    text,
                    score,
                    createdAt,
                    updatedAt
            },
            {
                    id,
                    foodName,
                    text,
                    score, 
                    createdAt,
                    updatedAt

            },
            ...
            
    ],
    meassge:"ok"
}

400

"fail"

401

"Unauthorized"

get comments by food_id

GET https://server.recipe101.net/comment/food/:id

Path Parameters

Name	Type	Description
:id	integer	food_id

200

{
    data:[
            {
                    id,
                    username,
                    text,
                    score,
                    createdAt,
                    updatedAt
            },
            {
                    id,
                    username,
                    text,
                    score,
                    createdAt,
                    updatedAt
            },
            ...
            
    ],
    meassge:"ok"
}

400

"fail"

401

"Unauthorized"

search recipe using user name

GET https://server.recipe101.net/search/username/:username

Path Parameters

Name	Type	Description
:username	string	username

200

{
    data: {
        recipes: [
            {
                food_id,
                food_name,
                food_img,
                level,
                cooking_time,
                score
            },
            ...
        ],
    }
    message: "ok"
}

400

"fail"

401

"Unauthorized"

search recipe using food name

GET https://server.recipe101.net/search/foodname/:foodname

Path Parameters

Name	Type	Description
:foodname	string	food_name

200

{
    data: {
        recipes: [
            {
                food_id,
                food_name,
                food_img,
                level,
                cooking_time,
                score
            },
            ...
        ],
    }
    message: "ok"
}

400

"fail"

401

"Unauthorized"

search recipe using item name

GET https://server.recipe101.net/search/itemname/:itemname&itemname1

Path Parameters

Name	Type	Description
:itemname	string	item_name
&itemname1	string	additional item_name

200

{
    data: {
        recipes: [
            {
                food_id,
                food_name,
                food_img,
                level,
                cooking_time,
                score
            },
            ...
        ],
    }
    message: "ok"
}

400

"fail"

401

"Unauthorized"

social signin (kakao)

GET https://server.recipe101.net/kakao

Request Body

Name	Type	Description
code	string	authorization_code

200

{
    accessToken:"accessToken",
    userinfo: { username, email, phone, userimage },
     },
    message:"ok"
}

400

"fail"

401

"Unauthorized"

get image

GET https://server.recipe101.net/image/:name

Path Parameters

Name	Type	Description
name	string	image name

200

image

400

"fail"

recently recipe

GET https://server.recipe101.net/recent/:num

Path Parameters

Name	Type	Description
num	number	number of recipes

200

{
    data: {
        recipes: [
            {
                food_id,
                food_name,
                food_img,
                level,
                cooking_time,
                score
            },
            ...
        ],
    }
    message: "ok"
}

400

"fail"

recommend recipe

GET https://server.recipe101.net/recommend/:num

Path Parameters

Name	Type	Description
num	number	number of recipes

200

{
    data: {
        recipes: [
            {
                food_id,
                food_name,
                food_img,
                level,
                cooking_time,
                count,
                score
            },
            ...
        ],
    }
    message: "ok"
}

400

"fail"

signin

POST https://server.recipe101.net/signin

Request Body

Name	Type	Description
username	string	username
password	string	password

200

{
    accessToken:"accessToken",
    message:"ok"
}

400

"fail"

signup

POST https://server.recipe101.net/signup

Request Body

Name	Type	Description
userName	string
password	string
email	string
phone	string
userImage	string	userimage

200

{
    accessToken:"accessToken",
    message:"ok"
}

400

"fail"

add recipe

POST https://server.recipe101.net/recipe

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
Food_info	object	cook information include: {foodName, summary, nation, type,cookingTime, calorie, qnt, level}
Ingredients	array	Ingredients for cook include: {name, type, cap}
Recipe	array	how to cook describe step by step include: {cookingNo, cookingDc, stepTip}
foodImage	string	foodimage
stepImage	string	stepimages

200

{ message: "ok" }

400

"fail"

401

"Unauthorized"

password check

POST https://server.recipe101.net/password

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
password	string	password

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

add subscribe

POST https://server.recipe101.net/subscribe

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
username	string	username

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

store recipe

POST https://server.recipe101.net/store

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
id	integer	food_id

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

create comment

POST https://server.recipe101.net/comment

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
id	integer	food_id
userName	string	username
comment	string	comment text
score	number	score

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

update recipe info

PATCH https://server.recipe101.net/recipe/:id

Path Parameters

Name	Type	Description
id	string	update recipe id

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
Food_info	object	cook information include: {food_name, summary, nation, type,cooking_time, calorie, qnt, level, (option):food_img}
Ingredients	array	Ingredients for cook include: {name, type, cap}
Recipe	array	how to cook describe step by step include: {cooking_no, cooking_dc (option): step_image, step_tip}
foodImage	string	foodimage
stepImage	string	stepimages

200

{ message: "ok" }

400

"fail"

401

"Unauthorized"

update userinfo

PATCH https://server.recipe101.net/user

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
userName	string
email	string
phone	string
userImage	string	userimage

200

{ message: "information updated" }

400

"fail"

401

"Unauthorized"

password update

PATCH https://server.recipe101.net/password

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
password	string	new password

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

update comment

PATCH https://server.recipe101.net/comment/:id

Path Parameters

Name	Type	Description
id	integer	comment id

Headers

Name	Type	Description
authorization	string	access token

Request Body

Name	Type	Description
comment	string	comment text
score	number	recipe score

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

delete recipe

DELETE https://server.recipe101.net/recipe/:id

Path Parameters

Name	Type	Description
:id	integer	food_id

Headers

Name	Type	Description
authorization	string	access token

200

{ message: "ok" }

400

"fail"

401

"Unauthorized"

delete user

DELETE https://server.recipe101.net/user

Headers

Name	Type	Description
authorization	string	access token

200

{ message: "He (or She)'s gone" }

400

"fail"

401

"Unauthorized"

Cancel subscription

DELETE https://server.recipe101.net/subscribe/:name

Path Parameters

Name	Type	Description
name	string	userName

Headers

Name	Type	Description
authorization	string	access token

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

remove stored recipe

DELETE https://server.recipe101.net/store

Path Parameters

Name	Type	Description
food_id	string	food_id

Headers

Name	Type	Description
authorization	string	access token

200

{message:"ok"}

400

"fail"

401

"Unauthorized"

remove comment

DELETE https://server.recipe101.net/comment/:id

Path Parameters

Name	Type	Description
id	integer	comment id

Headers

Name	Type	Description
authorization	string	acess token

200

{message:"ok"}

400

"fail"

401

"Unauthorized"