Tài liệu bàn giao dự án SDK_Signning (Service-Proxy)

phác thảo cấu trúc và nội dung chi tiết cho bộ tài liệu

CHƯƠNG 1: GIỚI THIỆU & BÀI TOÁN NGHIỆP VỤ

Tài liệu này được biên soạn cho dự án service-proxy (SDK_Signning) nhằm mục đích bàn giao cho đội...

Trang 1: Tổng quan dự án

1.1 Định nghĩa service-proxy là một thành phần trung gian (Middleware/API Gateway) được phát tri...

Trang 2: Bài toán nghiệp vụ & Giải pháp kỹ thuật

Dự án ra đời nhằm giải quyết 4 thách thức lớn trong quá trình vận hành hệ thống ký số cũ: 2.1 Th...

CHƯƠNG 2: KIẾN TRÚC KỸ THUẬT

Chương này cung cấp cái nhìn sâu sắc về mặt kỹ thuật, giúp Developer hiểu cách hệ thống vận hành ...

Trang 1: Công nghệ cốt lõi (Core Stack)

Dự án được xây dựng dựa trên các tiêu chuẩn hiện đại của Java Ecosystem: Framework chính: Spri...

Trang 2: Cấu hình WebClient & Kết nối

Lớp WebClientConfig đóng vai trò quan trọng trong việc thiết lập giao tiếp mạng: 2.1 Xử lý dung ...

Trang 3: Cơ chế Kháng lỗi (Resiliency)

Hệ thống sử dụng cơ chế Retry-with-Recovery tại lớp ExternalApiClient: 3.1 Cơ chế Retry Sử dụng...

Trang 4: Phân tích cấu trúc mã nguồn

Cấu trúc Package được tổ chức theo chuẩn Clean Architecture đơn giản: Package Trách nhi...

CHƯƠNG 3: HƯỚNG DẪN VẬN HÀNH & DEV

Chương này được thiết kế như một bản hướng dẫn từng bước (Step-by-step) để cài đặt, cấu hình và k...

Trang 1: Chuẩn bị môi trường

Để chạy dự án service-proxy, hệ thống cần cài đặt sẵn các thành phần sau: Java Development Kit...

Trang 2: Cấu hình hệ thống

Hệ thống hỗ trợ cấu hình linh hoạt thông qua file application.yml hoặc các biến môi trường (Envir...

Trang 3: Build & Deployment

Dự án đã tích hợp sẵn các script tự động hóa cho các hệ điều hành: 3.1 Triển khai trên Windows ...

Trang 4: Logging & Giám sát (Monitoring)

4.1 File Log Windows: Log được ghi song song vào Console và file app.log tại thư mục gốc của d...

CHƯƠNG 4: DANH MỤC API (API REFERENCE)

Tất cả các API dưới đây đều được Proxy chuyển tiếp (Forward) tới các Service Backend tương ứng. P...

Trang 1: Nhóm API Ký số (Signing Proxy)

Endpoint Method Mô tả /api/sign/scan-keywords POST Quét tọa độ từ khóa (keywor...

Trang 2: Nhóm API Quy trình (BPMN Proxy)

Endpoint Method Mô tả /api/proxy/start POST Khởi tạo một phiên quy trình nghiệ...

CHƯƠNG 5: BẢO TRÌ & MỞ RỘNG

Cách duy trì và phát triển

Trang 1: Xử lý lỗi & Recovery chuyên sâu

Hệ thống sử dụng ExternalApiClient làm trung tâm điều phối. Nếu bạn muốn thay đổi logic xử lý khi...

Trang 2: Hướng dẫn thêm Endpoint Proxy mới

Để thêm một đường dẫn Proxy mới vào hệ thống, hãy thực hiện 3 bước: Bước 1 (Controller): Tạo p...

Trang 3: Check-list bàn giao cho Dev tiếp quản

Kiểm tra file application.yml đã đúng URL của môi trường mới chưa. Bật logging.level.com.exa...