---
title: 行雲知識王 API 整合改動
tags: 行雲知識王, 寒訓
---

[< 回首頁](/TTNiCAWfRz6aGHQfw-Zrrw)

[TOC]

# 行雲知識王 API 整合改動
Postman 範例 Collection (用於匯入 Postman): https://www.getpostman.com/collections/98a6af1a85772b367ff1

API 有以下改動：

# Login

## 回應資料改動
- [移除] total_question_amount
- [移除] total_answered_amount
- [移除] total_correct_amount
- [移除] total_time_limit
- [移除] total_time_used

# Register

## 回應資料改動
與登入資料類似

# User

## method 改動
- [移除] /verify (直接使用登入 API 即可)
- [移除] /logout (系統無須 logout)

## 回應資料改動
- registration_time -> registered_at

| From | To |
| :------: | :------: |
|  |  |

## 可更新資料如下
- name
- email
- password

# Topic

## 回應資料改動
- group_id -> group (object)

From:
{
  group_id: 1
}

To:
{
  group: {
    id: 1,
    name: "XX 組",
    image_path: null
  }
}

| From | To |
| :------: | :------: |
|  |  |

# Game

## 回應資料改動
- time -> created_at
- [移除] user_id (都是個人的歷史紀錄，不需要 user_id)
- [移除] average_correct_rate (交由前端計算)
- [移除] average_react_rate (交由前端計算)

| From | To |
| :------: | :------: |
|  |  |

# History

## 回應資料改動
- time -> created_at
- [移除] user_id (都是個人的歷史紀錄，不需要 user_id)
- [移除] average_correct_rate (交由前端計算)
- [移除] average_react_rate (交由前端計算)
- [新增] total_question_amount (總問題數，用以計算平均)
- details 中大量改動
- [移除] history_id (上方已有 id)
- time -> updated_at
- question properties -> question (object)
- topic properties -> topic (object) in question
- group properties -> group (object) in question.topic

| From | To |
| :------: | :------: |
|  |  |

# Scoreboard

## 回應資料改動
user -> user (Object)

原先是一個陣列，前三個為該類別前三名，第四個為使用者本人。
現改為 Object 內含兩個 key，leaderboard 代表前三名，own 代表個人分數。

| From | To |
| :------: | :------: |
|  |  |