lập trình python hướng dẫn về cách sử dụng api cho một số trường hợp sử dụng phổ biến tại mangadex

 3xx: Redirection Chuyển hướng: Mã trạng thái này cho biết client cần có thêm action để hoàn thành request 4xx: Client Error Lỗi Client: Nó nghĩa là request chứa cú pháp không chính xá

TRƯỜNG ĐẠI HỌC THĂNG LONG

KHOA TOÁN TIN

LẬP TRÌNH PYTHON

HƯỚNG DẪN VỀ CÁCH SỬ DỤNG API CHO MỘT SỐTRƯỜNG HỢP SỬ DỤNG PHỔ BIẾN TẠI MANGADEX

HÀ NỘI – 2023

LỜI CẢM ƠN

Lời đầu tiên em xin chân thành cảm ơn thầy Hồ Hồng Trường – giảng viên môn Lập trình Python, đã hỗ trợ, hướng dẫn và giải đáp những thắc mắc của em trong suốt quá trình thực hiện để em có thể hoàn thành tốt bài tập lớn cuối kỳ của mình.

Quá trình thực hiện, nhóm đã vận dụng những kiến thức được giảng dạy đồng thời tìm hiểu thêm từ những nguồn thông tin bên ngoài để có thể phát triển hơn ý tưởng của nhóm Dù vậy, vẫn không thể tránh khỏi những sai sót xảy ra trong quá trình tìm hiểu và thực hiện.

Do đó, em luôn mong nhận được sự góp ý từ thầy để hiểu rõ hơn về kiến thức liên quan đến môn học, cũng như có được kinh nghiệm để tiếp tục thực hiện các đề tài, dự án tiếp theo trong thời gian tới Em xin chân thành cảm ơn Thầy rất nhiều!

MỤC LỤC

LỜI CẢM ƠN 2

PHẦN 1 : PHÂN CHIA CÔNG VIỆC 3

PHẦN 2 : GIỚI THIỆU VỀ API 3

PHẦN 3 : GIỚI THIỆU VỀ ĐỀ TÀI CỦA NHÓM 4

PHẦN 4 : MÔ TẢ CÁC ENDPOINT 4

PHẦN 5 : MÔ TẢ SWAGGER IU 5

PHẦN 1 : PHÂN CHIA CÔNG VIỆC

1 A40643 Nguyễn Đình Đạt (nhóm trưởng) : code, chuẩn bị tài liệu đề tài

2 A40639 Nguyễn Thanh Ngân : Chuẩn bị tài liệu swagger UI, làm báo cáo

3 A40810 Phạm Dương Duy : làm slide 4 A40985 Bùi Tiến Dũng : thuyết trình

PHẦN 2 : GIỚI THIỆU VỀ API

API là viết tắt của Application Programming Interface – phương thức trung gian kết nối các ứng dụng và thư viện khác nhau.

Nó cung cấp khả năng truy xuất đến một tập các hàm hay dùng, từ đó có thể trao đổi dữ liệu giữa các ứng dụng API được xây dựng dựa trên chính 2 thành phần : Request

HTTP request có tất cả 9 loại method , 2 loại được sử dụng phổ biến nhất là GET và POST

 GET: Sử dụng để lấy thông tin từ server theo URI đã

 PUT: Ghi đè tất cả thông tin của đối tượng với những gì được gửi lên.

 PATCH: Ghi đè các thông tin được thay đổi của đối tượng.

 DELETE: Xóa resource trên server.

 CONNECT: Thiết lập một kết nối tới server theo URI  OPTIONS: Mô tả các tùy chọn giao tiếp cho

 TRACE: Thực hiện một bài test loop-back theo đường dẫn đến resource.

3 Header

Là nơi chứa các thông tin cần thiết của 1 request nhưng end-users không biết có sự tồn tại của nó Ví dụ: độ dài của request body, thời gian gửi request, loại thiết bị đang sử dụng, loại định dạng cái response mà client có đọc được…

4 Body

Là nơi chứa thông tin mà client sẽ điền  Về Response :

Sau khi nhận được request từ phía client, server sẽ xử lý cái request đó và gửi ngược lại cho client 1 cái response Cấu trúc của 1 response tương đối giống phần request nhưng Status code sẽ thay thế cho URL và Method Tóm lại, nó có cầu trúc 3 phần:

 Status code  Headers  Body

Phần Header và body tương đối giống với request.

Status code của response

Status code (Mã hóa trạng thái thường được gọi là mã trạng thái) là một số nguyên 3 ký tự, trong đó ký tự đầu tiên của Status-Code định nghĩa loại Response và hai ký tự cuối không có bất cứ vai trò phân loại nào Có 5 giá trị của ký tự đầu tiên:

 1xx: Information (Thông tin): Khi nhận được những mã như vậy tức là request đã được server tiếp nhận và quá trình xử lý request đang được tiếp tục  2xx: Success (Thành công): Khi nhận được những

mã như vậy tức là request đã được server tiếp nhận, hiểu và xử lý thành công

 3xx: Redirection (Chuyển hướng): Mã trạng thái này cho biết client cần có thêm action để hoàn thành request

 4xx: Client Error (Lỗi Client): Nó nghĩa là request chứa cú pháp không chính xác hoặc không được thực hiện.

 5xx: Server Error (Lỗi Server): Nó nghĩa là Server thất bại với việc thực hiện một request nhìn như có vẻ khả thi.

PHẦN 3 : GIỚI THIỆU VỀ ĐỀ TÀI CỦA NHÓM

Mục đích của tài liệu này là cung cấp hướng dẫn về cách sử dụng API cho một số trường hợp sử dụng phổ biến tại mangadex

Sửa chữa các thông tin của manga

Lấy thông của các manga xong tổng hợp thành báo cáo

PHẦN 4 : MÔ TẢ CÁC ENDPOINT

1 GET "/": Endpoint này trả ra thông báo chào mừng và hướng dẫn người dùng truy cập trang tài liệu API 2 GET "/manga": Endpoint trả ra tất cả các thông tin

của các manga có trong cơ sở dữ liệu 3 GET "/manga/rating": Endpoint này trả ra các

manga có điểm rating lớn hơn rating mà người dùng yêu cầu.

4 GET "/manga/view/id": Endpoint này trả ra tổng số lượt xem của một manga cụ thể dựa theo ID mà người dùng yêu cầu.

5 GET "/manga/genre": Endpoint này trả ra các manga có thể loại mà người dùng yêu cầu 6 GET "/manga/author": Endpoint này trả ra các

manga có tác giả mà người dùng yêu cầu 7 GET "/manga/status": Endpoint này trả ra các

manga có trạng thái mà người dùng yêu cầu 8 GET "/manga/chapter/id": Endpoint này trả ra số

chapter của 1 manga dựa theo ID mà người dùng yêu cầu

9 GET "/manga/other_name": Endpoint này trả ra tên khác của một manga dựa theo ID mà người dùng yêu cầu.

10 POST "/addManga": Endpoint này cho phép người dùng thêm 1 manga mới vào cơ sở dữ liệu với các thông tin tên truyện tranh, tác giả, trạng thái, thể loại và xếp hạng được người dùng cung cấp Kết quả trả về là ID của truyện tranh mới được thêm vào.

11 POST "/manga/rating": Endpoint này cập nhật xếp hạng của manga trong cơ sở dữ liệu với ID và rating manga được cung cấp Điểm cuối trả về thông báo xác nhận cập nhật thành công 12 POST "/manga/addchapter": Endpoint này

thêm một chương mới vào truyện tranh trong cơ sở dữ liệu với ID chương, ID truyện tranh, tên chương và số lượt xem được cung cấp Điểm cuối trả về thông báo xác nhận cập nhật thành công.

13 POST "/manga/status": Endpoint này cập nhật trạng thái của truyện tranh trong cơ sở dữ liệu với ID và trạng thái truyện tranh được cung cấp Điểm cuối trả về thông báo xác nhận cập nhật thành công.

14 POST "/manga/genre": Endpoint này cập nhật thể loại truyện tranh trong cơ sở dữ liệu với thể loại và ID truyện tranh được cung cấp Điểm cuối trả về thông báo xác nhận cập nhật thành công.

15 POST "/manga/other_name": Endpoint này cập nhật tên khác của truyện tranh trong cơ sở dữ liệu với ID truyện tranh được cung cấp và tên khác của truyện tranh Điểm cuối trả về thông báo xác nhận cập nhật thành công.

16 POST "/manga/author": Endpoint này cập nhật tác giả của manga trong cơ sở dữ liệu với ID manga và tên tác giả được cung cấp Điểm cuối trả về thông báo xác nhận cập nhật thành công.

17 POST "/manga/name": Endpoint này cập nhật tên truyện tranh trong cơ sở dữ liệu với ID truyện tranh và tên truyện tranh được cung cấp Điểm cuối trả về thông báo xác nhận cập nhật thành công.

PHẦN 5 : MÔ TẢ SWAGGER IU

1 GET "api_url/":

Params : NoResponse

"Chào bạn, hãy truy cập

http://127.0.0.1:8000/docs để xem hướng dẫn sử

"genre": "Action, Adventure, Comedy",

Responses{

"message": "Đã cập nhật tác giả mới cho Manga: 4 thành: Koyoharu Gotouge"

17 POST"api_url/manga/addchapter "

Params