Nhảy tới nội dung
Phiên bản: 1.0.0

Tổng quan

Rest project giúp bạn quản lý các rest endpoint của mình.

REST (Representational State Transfer) là một kiến trúc phần mềm được sử dụng phổ biến để xây dựng các dịch vụ web (web services) và APIs. REST định nghĩa các nguyên tắc và ràng buộc để thiết kế các hệ thống phân tán như web, cho phép các thành phần khác nhau trong hệ thống giao tiếp với nhau thông qua các giao thức tiêu chuẩn

Phần này hướng dẫn cách quản lý dự án rest trong Service Visualization:

Tạo mới một dự án rest​

Bạn có thể tạo một dự án rest bằng cách chọn Project Type là Rest. Để xem cách tạo một dự án, bạn có thể xem bài viết Tạo nhóm dự án create-rest-project.png

Quản lý các endpoint của dự án rest​

Để tạo và dừng endpoint, bạn có thể xem bài viết Tổng quan về endpoint

Chạy rest endpoint​

Bạn có thể chạy rest endpoint của mình thông qua tính năng Try It Now. Trang này chỉ hiển thị khi Endpoint ở trạng thái Running. Để sử dụng tính năng này, hãy thực hiện như sau:

Bước 1: Ấn nút Save để lưu những thay đổi của Endpoint

Bước 2: Ấn nút Start nếu Endpoint đang ở trạng thái Draft start-api.png Bước 3: Mở tab Try it now

Bước 4: Ấn Try it out để cấu hình các parameters, body và headers sẽ gửi đi try-it-now-tab.png Bước 5: Ấn Execute để gửi reqest đến endpoint execute-btn.png

Bước 6: Kiểm tra thông tin endpoint gửi đi và trả về có đúng như bạn mong đợi hay không endpoint-response.png

Curl: request gửi đi

Request Url: url của endpoint

Code: Mục này hiển thị các mã phản hồi (HTTP status codes) mà Endpoint có thể trả về. Một số mã phổ biến:

  • 200 OK: Yêu cầu thành công.

  • 404 Not Found: Không tìm thấy tài nguyên.

  • 500 Internal Server Error: Lỗi phía server.

Media type: Bạn có thể chọn kiểu dữ liệu mà Endpoint sẽ trả về. Ví dụ: application/json để nhận dữ liệu dưới dạng JSON.