Chương II Phân tích, thiết kế API Gateway
2.4. Phân tích ứng dụng quản trị API Gateway – API Management
STT ACTOR USERCASE
1 Người quản trị hệ thống Quản lý API
Quản lý ứng dụng
Quản lý hệ thống API Management
Quản lý hạn ngạch
Thống kê
2.4.2. Biểu đồ use case tổng quát
Hình 2. 17. Use case tổng quan AM
2.4.3. Chi tiết Use case quản lý API
Hình 2. 18. Usecase chi tiết quản lý API
STT Tên UC Quản lý API
1 Tác nhân Quản trị viên
2 Mục đích Quản lý API bên trong hệ thống microservices
3 Mô tả Thiết kế API: Khai báo các API cho API
Gateway quản lý và phơi ra ngoài.
Sửa API: Sửa thông tin các API đã khai báo Xóa API: Xóa được các API đã khai báo Chi tiết API: Bên trong chức năng sẽ có thể
xem chi tiết các thông tin API và quản lý các phiên bản API bao gồm: thêm, sửa, xóa, xem, quản lý vòng đời (1) API các phiên bản API đã tạo.
(1) Vòng đời của API
Một API được sau được được tạo mới để quản lý thì có các vòng đời(trạng thái):
Mới tạo, Phát hành, Bị chặn, Tạm dừng hoạt động, Chấm dứt hoạt động
Mới tạo: Trạng thái mới tạo tạo của API. Khi ở trạng thái này API chỉ hiển thị trong phần Publisher.
Phát hành: Trạng thái đánh dấu API đã được thêm vào Store cho phép các Developer dùng các API, nhưng muốn dùng các API thì cần phải đăng ký với nhà cung cấp API để được set quyền truy cập.
Bị chặn: là trạng thái tạm khóa API, nó hiển thị trên Store nhưng không
sử dụng được. Muốn sử dụng được các hàm do API cung cấp cần phải chuyển trạng thái.
Tạm dừng hoạt động: API bên trong đang tạm dừng để cập nhật
Chấm dứt hoạt động: trạng thái xóa API. Đây là trạng thái Block vĩnh viễn.
2.4.4. Chi tiết Use case quản lý ứng dụng
Hình 2. 19. Usercase chi tiết quản lý ứng dụng
STT Tên UC Quản lý ứng dụng
1 Tác nhân Quản trị viên
2 Mục đích Quản lý ứng dụng đăng ký sử dụng các API
3 Mô tả Tạo ứng dụng: Khai báo các ứng dụng
Sửa ứng dụng: Sửa thông tin các ứng dụng đã
khai báo
Xóa ứng dụng: Xóa được các ứng dụng đã
khai báo
Chi tiết ứng dụng: Bên trong chức năng sẽ có
thể xem chi tiết các thông tin ứng dụng, lấy API key của ứng dụng để bên ngoài có thể gọi vào, đăng ký sử dụng các API, lấy mã bảo mật của ứng dụng
2.4.5. Chi tiết Use case quản lý hệ thống AM
Hình 2. 20. Usecase quản lý hệ thống AM
STT Tên UC Quản lý hệ thống AM
1 Tác nhân Quản trị viên
2 Mục đích Quản lý các chức năng, người dùng, nhóm, các
nút trong ứng dụng API Management
3 Mô tả Quản trị chức năng: Quản lý các chức năng
được hiện thị trên ứng dụng AM
Quản trị người dùng: Thêm sửa xóa, cấp
quyền người dùng ứng dụng AM
Quản trị nhóm ứng dụng: quản lý các nhóm
người dùng. Phân các chức năng cho các nhóm người dùng
2.4.6. Chi tiết Use case quản lý danh sách đen
Hình 2. 21. Usecase quản lý danh sách đen
STT Tên UC Quản lý danh sách đen
1 Tác nhân Quản trị viên
2 Mục đích Quản lý các các IP, dải IP phải chặn không cho
truy cập vào hệ thống bên trong
3 Mô tả Thêm IP: Thêm IP, dải IP ví dụ: 192.168.*.*
vào danh sách đen
Sửa IP: Sửa IP, dải IP trong danh sách đen Xóa IP: Xóa IP, dải IP trong danh sách đen Xem danh sách: Tìm kiếm và hiện thị danh
sách IP, dải IP
Xem chi tiết IP: Xem chi tiết thông tin IP, dải
IP bị chặn
2.4.7. Chi tiết Use case quản lý hạn ngạch
Hình 2. 22. Usecase quản lý hạn ngạch
STT Tên UC Quản lý hạn ngạch
1 Tác nhân Quản trị viên
2 Mục đích Quản lý request count limit và bandwidth limit
trên API Gateway
3 Mô tả Thêm hạn ngạch: Thêm các thông số giới hạn
request count và bandwidth cho API Gateway
Sửa hạn ngạch: Sửa các thông số hạn nghạch,
cho phép / không cho phép áp dụng hạn ngạch
Xóa hạn ngạch Xem danh sách hạn ngạch: Tìm kiếm và
danh sách các hạn ngạch đã tạo
Xem chi tiết hạn ngạch
2.4.8. Chi tiết Use case thống kê
Hình 2. 23. Usecase thống kê
STT Tên UC Thống kê
1 Tác nhân Quản trị viên
2 Mục đích Xem log, xem các thông số của API Gateway
3 Mô tả Số lần truy cập dịch vụ: đếm số lần gọi API,
số ứng dụng đăng ký API
Thời gian sử dụng gần nhất: xem thời gian
được sử dụng gần nhất của các API
Các lỗi ngoại lệ: Xem log các lỗi ngoại lệ của
API Gateway khi nhận request từ bên ngoài Tất cả thông điệp trao đổi qua cổng dịch vụ: Xem tất cả log của tất cả API