Tổng quan

Tổng quan

RESTful API là một kiểu thiết kế API (Application Programming Interface) dựa trên kiến trúc REST (Representational State Transfer) – một phong cách kiến trúc cho hệ thống phân tán, đặc biệt là các ứng dụng web. RESTful API cho phép các hệ thống giao tiếp với nhau qua HTTP bằng cách sử dụng các phương thức HTTP tiêu chuẩn như: GET, POST, PUT, DELETE.

Mỗi API đại diện cho một resource (tài nguyên) được định danh bằng một URL, và dữ liệu thường được trao đổi ở định dạng JSON hoặc XML.

REST Project là một đơn vị tổ chức trong hệ thống Service Visualization, đại diện cho một dự án API mô phỏng được xây dựng dựa trên chuẩn RESTful API. Mỗi REST Project bao gồm nhiều endpoint được cấu hình để mô phỏng hành vi của các API thật, phục vụ cho mục đích phát triển, kiểm thử, hoặc tích hợp hệ thống mà không cần kết nối trực tiếp với backend.

REST Project bao gồm:

• Các endpoint theo cấu trúc REST API : Các API giả lập với method và path cụ thể (ví dụ: POST /auth, GET /orders), được cấu hình trả về dữ liệu phản hồi.
• Schemas: Định nghĩa cấu trúc dữ liệu JSON để dùng cho request và response.
• Document: Tài liệu mô tả dự án và luồng xử lý các API trong dự án.
• Statistic: Lịch sử các lần gọi đến các API trong dự án.

Mục tiêu của REST Project:

• Hỗ trợ phát triển frontend hoặc test tự động khi backend chưa sẵn sàng.
• Giảm phụ thuộc vào hệ thống thật, tăng tính chủ động.
• Dễ dàng mô phỏng các lỗi hoặc trường hợp đặc biệt không dễ tạo ra với API thật.

Tạo mới REST Project

Để tạo mới một REST Project trên hệ thống Service Visualization, thực hiện như sau:

Bước 1: Tại thao tác tạo mới project, chọn kiểu project là REST.

Bước 2: Sau khi nhấn Create, hệ thống lưu thông tin và hiển thị màn hình chi tiết REST Project, thực hiện các thao tác làm việc với project.