Tổng quan về API

Chuẩn bị

• Yêu cầu
  • Postman, wget hoặc tương tự
  • Wafter bản chính thức mới nhất
• Chạy thử nghiệm
  • Bật máy chủ và đảm bảo máy chủ bình thường
  • Ở Postman, tạo 1 request mới tới localhost:3001/api/info. Cần đảm bảo rằng có trả về thông tin kỳ thi hiện tại. ví dụ:

{
    "name": "Kỳ thi thử",
    "mode": "OI",
    "startTime": "2019-02-15T14:00:00.000Z",
    "endTime": "2019-02-15T15:00:00.000Z",
    "probList": ["A", "B", "C", "D", "E", "F"],
    "allowedCodeExt": [".C", ".CPP", ".JAVA", ".PAS", ".PY"],
	"allowEveryoneReg": false
}

Sử dụng API

Cookies

Sau khi đăng nhập, để nâng cao trải nghiệm người dùng, thông tin session hiện tại của người dùng sẽ được lưu vào cookies.

Dữ liệu trả về của API

Dữ liệu của API được trả về theo kiểu file JSON - JavaScript Object Notation. Ví dụ:

{
    "name": "Kỳ thi thử",
    "mode": "OI",
    "startTime": "2019-02-15T14:00:00.000Z",
    "endTime": "2019-02-15T15:00:00.000Z",
    "probList": ["A", "B", "C", "D", "E", "F"],
    "allowedCodeExt": [".C", ".CPP", ".JAVA", ".PAS", ".PY"],
	"allowEveryoneReg": false
}

Cụ thể trong đó:

Tên	Mô tả	Kiểu dữ liệu
name	Tên kỳ thi	String
mode	Hình thức chấm bài	String
startTime	Thời gian bắt đầu kỳ thi	Date
endTime	Thời gian kết thúc kỳ thi	Date
probList	Danh sách mã bài	Array<String>
allowedCodeExt	Danh sách các đuôi file cho phép	Array<String>
allowEveryoneReg	Cho phép mọi người đăng kí tài khoản	Boolean

Lỗi

Nếu máy chủ trả về HTTP Error Code lớn hơn hoặc bằng 400, nghĩa là có lỗi xảy ra. Chi tiết lỗi có thể đọc tại đây