# API 文件

:::info
### Root Path：`/api/`
:::

所有 api 區分成六個類別：

* /users
* /songs
* /playlists
* /articles
* /posts
* /admin

## 使用者（users）

### 帳戶相關

| 說明 | Method | Path |
| --- | --- | --- |
| 註冊使用者 | POST | /users/register |
| 登入使用者 | POST | /users/login |
| 登出使用者 | GET | /users/logout |
| 取得個人使用者資料 | GET | /users/me |
| 修改個人使用者資料 | PATCH | /users/me |
| 刪除帳號 | DELETE | /users/me |
| 修改個人密碼 | PATCH | /users/password |
| 申請成為音樂創作者 | POST | /users/apply |

### 功能相關

| 說明 | Method | Path |
| --- | --- | --- |
| 取得創作者動態 | GET | /users/:id |
| 取得創作者作品 | GET | /users/:id/songs |
| 取得創作者關於 | GET | /users/:id/about |
| 追蹤創作者 | POST | /users/:id/follow |
| 取消追蹤創作者 | DELETE | /users/:id/follow |
| 取得使用者追蹤的創作者 | DELETE | /users/follow/:id |
| 取得使用者收藏的歌曲 | GET | /users/songs/likes |
| 取得使用者追蹤的創作者 | GET | /users/follow |
| 追蹤的創作者 | GET | /users/follow |

## 歌曲（songs）

| 說明 | Method | Path |
| --- | --- | --- |
| 取得歌曲搜尋結果 | GET | /songs/search/`<keyword>` |
| 取得熱門歌曲排行榜 | GET | /songs/hot |
| 取得熱門歌曲排行榜（特定曲風） | GET | /songs/hot/`<genre>` |
| 取得新歌排行榜 | GET | /songs/latest |
| 取得新歌排行榜（特定曲風） | GET | /songs/latest/`<genre>` |
| 取得單一歌曲頁面 | GET | /songs/:id |
| 使用者收藏歌曲 | POST | /songs/:id/like |
| 使用者取消收藏歌曲 | DELETE | /songs/:id/like |
| 取得單一歌曲的所有留言 | GET | /songs/:id/messages |
| 新增單一歌曲的留言 | POST | /songs/:id/messages |
| 修改單一歌曲的留言 | PATCH | /songs/:id/messages/:msg_id |
| 刪除單一歌曲的留言 | DELETE | /songs/:id/messages/:msg_id |
| 取得作品列表 | GET | /songs |
| 上傳作品 | POST | /songs |
| 修改作品 | PATCH | /songs/:id |
| 刪除作品 | DELETE | /songs/:id |

## 歌單（playlists）

| 說明 | Method | Path |
| --- | --- | --- |
| 取得使用者的所有歌單 | GET | /playlists |
| 取得使用者的單一歌單 | GET | /playlists/:id |
| 新增單一歌單 | POST | /playlists |
| 修改單一歌單 | PATCH | /playlists/:id |
| 刪除單一歌單 | DELETE | /playlists/:id |
| 將單一歌曲加入單一歌單 | POST | /playlists/:id/songs/:song_id |
| 將單一歌曲移除單一歌單 | DELETE | /playlists/:id/songs/:song_id |

## 專欄文章（articles）

| 說明 | Method | Path |
| --- | --- | --- |
| 取得所有文章 | GET | /articles |
| 取得單一文章 | GET | /articles/:id |

## 動態貼文（posts）

| 說明 | Method | Path |
| --- | --- | --- |
| 取得動態列表 | GET | /posts |
| 新增動態 | POST | /posts |
| 修改動態 | PATCH | /posts/:id |
| 刪除動態 | DELETE | /posts/:id |

## 管理員（admin）

| 說明 | Method | Path |
| --- | --- | --- |
| 管理員登入 | POST | /admin/login |
| 管理員登出 | GET | /admin/logout |
| 取得所有使用者資料 | GET | /admin/users |
| 取得單一使用者資料 | GET | /admin/users/:id |
| 修改單一使用者資料 | POST | /admin/users/:id |
| 取得文章列表 | GET | admin/articles |
| 新增文章 | POST | /admin/articles |
| 修改文章 | PATCH | admin/articles/:id |
| 刪除文章 | DELETE | admin/articles/:id |