Chào mừng bạn đến với bài viết này, trong đó chúng ta sẽ tìm hiểu về cách viết API để quản lý thông tin sinh viên trong chương trình.
Contents
Giới thiệu
Trong quá trình phát triển phần mềm, việc tạo ra một giao diện API (Application Programming Interface) đóng vai trò quan trọng trong việc quản lý và truy xuất dữ liệu. Trong bài viết này, chúng ta sẽ tìm hiểu cách tạo ra một API để quản lý thông tin sinh viên.
Bước 1: Định nghĩa API
Trước tiên, chúng ta cần xác định Base URL cho API của mình. Trong ví dụ này, chúng ta sẽ sử dụng http://localhost:8080/StudentManagement
làm Base URL cho API.
API 1: Lấy danh sách sinh viên
Tên API: /api/student/list
Method: GET
Request: NONE
Response:
[
{
"rollno": "R001",
"fullname": "Tran Van A",
"email": "[email protected]",
"address": "Nam Dinh",
"birthday": "1999-02-06"
},
{
"rollno": "R002",
"fullname": "Tran Van B",
"email": "[email protected]",
"address": "Nam Dinh",
"birthday": "1999-06-06"
}
]
API 2: Thêm sinh viên
Tên API: /api/student/add
Method: POST
Request:
{
"data": {
"rollno": "R003",
"fullname": "Tran Van C",
"email": "[email protected]",
"address": "Nam Dinh",
"birthday": "1999-08-06"
}
}
Response:
{
"status": "success",
"message": "Thêm sinh viên thành công"
}
API 3: Sửa thông tin sinh viên
Tên API: /api/student/update
Method: POST
Request:
{
"data": {
"rollno": "R003",
"fullname": "Tran Van C",
"email": "[email protected]",
"address": "Nam Dinh",
"birthday": "1999-08-06"
}
}
Response:
{
"status": "success",
"message": "Sửa thông tin sinh viên thành công"
}
API 4: Xóa sinh viên
Tên API: /api/student/delete
Method: POST
Request:
{
"data": {
"rollno": "R003"
}
}
Response:
{
"status": "success",
"message": "Xóa sinh viên thành công"
}
Bước 2: Phát triển Backend
Sau khi đã định nghĩa các API, chúng ta cần triển khai Backend để xử lý các yêu cầu từ phía client. Dưới đây là một số thông tin về cách phát triển Backend cho ứng dụng quản lý sinh viên.
Thiết kế database
Chúng ta cần tạo một bảng student
để lưu trữ thông tin sinh viên trong cơ sở dữ liệu của chương trình. Dưới đây là cấu trúc của bảng student
:
create table student (
rollno varchar(20) primary key,
fullname varchar(50),
email varchar(150),
address varchar(200),
birthday date
)
Kết nối CSDL <=> Project
Sử dụng ORM (Object-Relational Mapping), chúng ta cần thiết lập kết nối giữa Cơ sở dữ liệu và Project. Dưới đây là một số thông tin cần thiết:
const BASE_URL = 'http://localhost:8080/StudentMgr'
// Sinh Viên
const API_STUDENT_LIST = '/api/student/list'
const API_STUDENT_ADD = '/api/student/add'
const API_STUDENT_UPDATE = '/api/student/update'
const API_STUDENT_DELETE = '/api/student/delete'
Kết
Trên đây là cách viết API để quản lý thông tin sinh viên trong chương trình. Qua bài viết này, bạn đã biết cách tạo ra các API để lấy danh sách sinh viên, thêm, sửa và xóa thông tin của sinh viên. Hy vọng rằng bài viết này đã giúp bạn có một cái nhìn tổng quan về quá trình viết API và áp dụng vào các dự án của mình.