System Context

Code To UML đưa Diagram as Code vào Playground, VS Code, GitLab, Confluence và các website tài liệu. Người dùng tiếp tục soạn thảo và review trong công cụ quen thuộc, còn Code To UML tiếp nhận mã sơ đồ và trả kết quả về đúng điểm hiển thị.

Bối cảnh hệ thống

Người dùng có thể lần lượt là tác giả, reviewer hoặc người đọc tùy công việc. Người vận hành quản lý môi trường chạy, cấu hình và secret của rendering service. VS Code, GitLab, Confluence Cloud và website tài liệu là nơi người dùng tạo hoặc xem nội dung; các integration của Code To UML đưa source từ những công cụ này tới rendering service và đưa kết quả trở lại màn hình đang sử dụng.

Phạm vi sản phẩm

Code To UML gồm Playground, VS Code Extension, GitLab Markdown Integration, GitLab MR Browser Extension, Confluence Forge app, MkDocs integration và rendering service. Java Core cùng phần lớn renderer được kế thừa từ Kroki, sau đó được dự án cấu hình, mở rộng và đóng gói trong bản phân phối Code To UML.

Mã sơ đồ và lịch sử thay đổi được lưu tại workspace, GitLab repository, Confluence page hoặc source của website tài liệu. VS Code, GitLab, Confluence và máy chủ website tiếp tục quản lý quyền đọc, chỉnh sửa nội dung tương ứng; Code To UML chỉ tiếp nhận source cần render và trả kết quả.

Dữ liệu và quyền truy cập

Preview, export và các backend integration gửi request POST kèm token lấy từ nơi lưu trữ riêng của client hoặc backend. Với sơ đồ nhúng trong GitLab hoặc website tài liệu, browser tải ảnh qua encoded GET. Mã sơ đồ trong URL có thể được khôi phục, vì vậy đường dẫn này chỉ phù hợp với nội dung được phép xuất hiện trong URL và access log.

Các thành phần xử lý request được trình bày trong Component Architecture; hai cách gọi API được mô tả tại Integration Flows.