> For the complete documentation index, see [llms.txt](https://allaboutme.gitbook.io/all-about-me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://allaboutme.gitbook.io/all-about-me/master.md).

# Initial page

## login

<mark style="color:green;">`POST`</mark> `https://localhost:4000/login`

#### Request Body

| Name     | Type   | Description |
| -------- | ------ | ----------- |
| email    | string |             |
| password | string |             |

{% tabs %}
{% tab title="200 Cake successfully retrieved." %}

```
{    "name": "kimcoding",    
     "email": "kimcoding@gmail.com",    
     "phone": "010-0000-0000"
}
```

{% endtab %}

{% tab title="401 Could not find a cake matching this query." %}

```
{    
    "message": "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

## signUp

<mark style="color:green;">`POST`</mark> `https://localhost:4000/signup`

#### Request Body

| Name     | Type   | Description |
| -------- | ------ | ----------- |
| email    | string |             |
| password | string |             |
| name     | string |             |
| phone    | string |             |

{% tabs %}
{% tab title="201 " %}

```
{
    "message" : "ok"
}
```

{% endtab %}

{% tab title="409 " %}

```
{
    "message" : "Conflict"
}
```

{% endtab %}

{% tab title="422 " %}

```
{
    "message" : "Unprocessable Ent"
}
```

{% endtab %}
{% endtabs %}

## logout

<mark style="color:blue;">`GET`</mark> `https://localhost:4000/logout`

{% tabs %}
{% tab title="200 " %}

```
{
    "message" : "ok"
}
```

{% endtab %}
{% endtabs %}

## googleLogin

<mark style="color:green;">`POST`</mark> `https://localhost:4000/login/google`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{    
     "name": "kimcoding",    
     "email": "kimcoding@gmail.com",    
     "phone": "010-0000-0000"
}
```

{% endtab %}

{% tab title="401 " %}

```
{    
    "message": "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

## githubLogin

<mark style="color:green;">`POST`</mark> `https://localhost:4000/login/github`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{    
     "name": "kimcoding",    
     "email": "kimcoding@gmail.com",    
     "phone": "010-0000-0000"
}
```

{% endtab %}

{% tab title="401 " %}

```
{    
    "message": "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

## userInfo

<mark style="color:blue;">`GET`</mark> `https://localhost:4000/user/:id`

#### Headers

| Name          | Type   | Description |
| ------------- | ------ | ----------- |
| authorization | string |             |

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "userinfo" : {
            "email" : "kimcoding@gmail.com"
            "name" : "kimcoding"
            "phone" : "010-0000-0000"
        }
    }
}
```

{% endtab %}

{% tab title="401 " %}

```
{
    "message" : "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

## modifyUser

<mark style="color:orange;">`PUT`</mark> `https://localhost:4000/user/:id`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |
| email       | string |             |
| password    | string |             |
| name        | string |             |
| phone       | string |             |

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "userinfo" : {
            "email" : "kimcoding@gmail.com"
            "name" : "kimcoding"
            "phone" : "010-0000-0000"
        }
    }
}
```

{% endtab %}

{% tab title="401 " %}

```
{
    "message" : "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

## deleteUser

<mark style="color:red;">`DELETE`</mark> `https://localhost:4000/user/:id`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{
    "message" : "ok"
}
```

{% endtab %}
{% endtabs %}

## loadFavorite

<mark style="color:blue;">`GET`</mark> `https://localhost:4000/user/favorite/:id`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "favorite" : [
            { "id" : "1", "testname" : "한식", "selectname" : "비빔밥"},
            { "id" : "2", "testname" : "동물", "selectname" : "강아지"},
        ]
    }
}
```

{% endtab %}

{% tab title="404 " %}

```
{
    "message" : "Not Found"
}
```

{% endtab %}
{% endtabs %}

## loadUserPost

<mark style="color:blue;">`GET`</mark> `https://localhost:4000/user/post/:id`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "post" : [
            { "id" : "1", "tag" : "비빔밥", "content" : "맛있당"},
            { "id" : "2", "tag" : "강아지", "content" : "귀엽당"},
        ]
    }
}
```

{% endtab %}

{% tab title="404 " %}

```
{
    "message" : "Not Found"
}
```

{% endtab %}
{% endtabs %}

## deleteFavorite

<mark style="color:red;">`DELETE`</mark> `https://localhost:4000/user/favorite/:id`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{
    "message" : "ok"
}
```

{% endtab %}
{% endtabs %}

## testlist

<mark style="color:blue;">`GET`</mark> `https://localhost:4000/test`

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "testlist" : [
            { "id" : "1", "name" : "비빔밥",},
            { "id" : "2", "name" : "강아지",},
        ]
    }
}
```

{% endtab %}
{% endtabs %}

## test

<mark style="color:blue;">`GET`</mark> `https://localhost:4000/test/:id`

#### Query Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | number |             |

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "test" : [
            { "id" : "1", "name" : "비빔밥" },
            { "id" : "2", "name" : "불고기" },
        ]
    }
}
```

{% endtab %}
{% endtabs %}

## saveFavorite

<mark style="color:green;">`POST`</mark> `https://localhost:4000/favorite`

#### Request Body

| Name     | Type   | Description |
| -------- | ------ | ----------- |
| userId   | number |             |
| selectId | number |             |
| testId   | number |             |

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "favorite" : [
            { "id" : "1", "testname" : "한식", "selectname" : "비빔밥"},
            { "id" : "2", "testname" : "동물", "selectname" : "강아지"},
        ]
    }
}
```

{% endtab %}

{% tab title="401 " %}

```
{
    "message" : "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

## loadPost

<mark style="color:blue;">`GET`</mark> `https://localhost:4000/post`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{ 
    "message" : "ok", 
    "data" : {
        "post" : [
            { "id" : "1", "tag" : "비빔밥", "content" : "맛있당"},
            { "id" : "2", "tag" : "강아지", "content" : "귀엽당"},
        ]
    }
}
```

{% endtab %}

{% tab title="401 " %}

```
{
    "message" : "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

## addPost

<mark style="color:green;">`POST`</mark> `https://localhost:4000/post`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

#### Request Body

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| userId  | number |             |
| content | string |             |

{% tabs %}
{% tab title="201 " %}

```
{
    "message" : "ok", 
    "data" : {
        "post" : { "id" : "1", "tag" : "비빔밥", "content" : "맛있당"}
    }
}
```

{% endtab %}

{% tab title="401 " %}

```
{
    "message" : "Unauthorized",
}
```

{% endtab %}
{% endtabs %}

## deletePost

<mark style="color:red;">`DELETE`</mark> `https://localhost:4000/post/:id`

#### Headers

| Name        | Type   | Description |
| ----------- | ------ | ----------- |
| accessToken | string |             |

{% tabs %}
{% tab title="200 " %}

```
{
    "message" : "ok",
}
```

{% endtab %}
{% endtabs %}