> For the complete documentation index, see [llms.txt](https://clout-tv.gitbook.io/api-docs-1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://clout-tv.gitbook.io/api-docs-1/reference/my-api.md).

# my API

## 전체 조회

<mark style="color:blue;">`GET`</mark> `https://kakao.gg/gboard/getAll`

전체 조회

#### Headers

| Name                                           | Type   | Description |
| ---------------------------------------------- | ------ | ----------- |
| Authoization<mark style="color:red;">\*</mark> | String | AccessToken |

#### Request Body

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| nickname<mark style="color:red;">\*</mark>  | String | nickname    |
| title<mark style="color:red;">\*</mark>     | String | title       |
| content<mark style="color:red;">\*</mark>   | String | content     |
| image<mark style="color:red;">\*</mark>     | String | image       |
| updatedAt<mark style="color:red;">\*</mark> | String | updatedAt   |
| hit                                         | String | hit         |
| like                                        | String | like        |

{% tabs %}
{% tab title="200: OK 전체 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 검색 조회

<mark style="color:blue;">`GET`</mark> `https://kakao.gg/gboard/:keyword`

검색 조회

#### Query Parameters

| Name                                      | Type   | Description |
| ----------------------------------------- | ------ | ----------- |
| keyword<mark style="color:red;">\*</mark> | String | keyword     |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

#### Request Body

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| image<mark style="color:red;">\*</mark>     | String | image       |
| nickname<mark style="color:red;">\*</mark>  | String | nickname    |
| title<mark style="color:red;">\*</mark>     | String | title       |
| content<mark style="color:red;">\*</mark>   | String | content     |
| updatedAt<mark style="color:red;">\*</mark> | String | updatedAt   |
| hit<mark style="color:red;">\*</mark>       | String | hit         |
| like<mark style="color:red;">\*</mark>      | String | like        |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 특정 게시글 조회

<mark style="color:blue;">`GET`</mark> `https://kakao.gg/gboard/:id`

특정 게시글 조회

#### Query Parameters

| Name                                 | Type   | Description |
| ------------------------------------ | ------ | ----------- |
| id<mark style="color:red;">\*</mark> | String | id          |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

#### Request Body

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| image<mark style="color:red;">\*</mark>     | String | image       |
| nickname<mark style="color:red;">\*</mark>  | String | nickname    |
| title<mark style="color:red;">\*</mark>     | String | title       |
| content<mark style="color:red;">\*</mark>   | String | content     |
| updatedAt<mark style="color:red;">\*</mark> | String | updatedAt   |
| hit<mark style="color:red;">\*</mark>       | String | hit         |
| like<mark style="color:red;">\*</mark>      | String | like        |
| comment<mark style="color:red;">\*</mark>   | String | comment     |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 게시글 작성

<mark style="color:green;">`POST`</mark> `https://kakao.gg/gboard/write`

게시글 작성

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

#### Request Body

| Name                                      | Type   | Description |
| ----------------------------------------- | ------ | ----------- |
| image<mark style="color:red;">\*</mark>   | String | image       |
| title<mark style="color:red;">\*</mark>   | String | title       |
| content<mark style="color:red;">\*</mark> | String | content     |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="404: Not Found 권한이 없습니다." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 게시글 수정

<mark style="color:purple;">`PATCH`</mark> `https://kakao.gg/gboard/:id`

게시글 수정

#### Query Parameters

| Name                                 | Type   | Description |
| ------------------------------------ | ------ | ----------- |
| id<mark style="color:red;">\*</mark> | String | id          |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

#### Request Body

| Name                                      | Type   | Description |
| ----------------------------------------- | ------ | ----------- |
| image<mark style="color:red;">\*</mark>   | String | image       |
| title<mark style="color:red;">\*</mark>   | String | title       |
| content<mark style="color:red;">\*</mark> | String | content     |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="404: Not Found 권한이 없습니다." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 게시글 삭제

<mark style="color:red;">`DELETE`</mark> `https://kakao.gg/gboard/:id`

게시글 작성

#### Query Parameters

| Name                                 | Type   | Description |
| ------------------------------------ | ------ | ----------- |
| id<mark style="color:red;">\*</mark> | String | id          |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="404: Not Found 권한이 없습니다." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 댓글 작성

<mark style="color:green;">`POST`</mark> `https://kakao.gg/gboard/:id`

댓글 작성

#### Query Parameters

| Name                                 | Type   | Description |
| ------------------------------------ | ------ | ----------- |
| id<mark style="color:red;">\*</mark> | String | id          |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

#### Request Body

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| comment<mark style="color:red;">\*</mark>   | String | comment     |
| updatedAt<mark style="color:red;">\*</mark> | String | updatedAt   |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="404: Not Found 권한이 없습니다." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 댓글 수정

<mark style="color:purple;">`PATCH`</mark> `https://kakao.gg/gboard/:id/:commentId`

댓글 수정

#### Query Parameters

| Name                                 | Type   | Description |
| ------------------------------------ | ------ | ----------- |
| id<mark style="color:red;">\*</mark> | String | id          |
| commentId                            | String | commentId   |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

#### Request Body

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| comment<mark style="color:red;">\*</mark>   | String | comment     |
| updatedAt<mark style="color:red;">\*</mark> | String | updatedAt   |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="404: Not Found 권한이 없습니다." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## 댓글 삭제

<mark style="color:red;">`DELETE`</mark> `https://kakao.gg/gboard/:id/:commentId`

댓글 삭제

#### Query Parameters

| Name                                 | Type   | Description |
| ------------------------------------ | ------ | ----------- |
| id<mark style="color:red;">\*</mark> | String | id          |
| commentId                            | String | commentId   |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | String | AccessToken |

{% tabs %}
{% tab title="200: OK 검색 조회" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error 서버 에러" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="404: Not Found 권한이 없습니다." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}