Bỏ qua để đến nội dung

Nhập một mô hình Smithy

Smithy là ngôn ngữ mô hình hóa API của AWS. Restorm nhập được cả hai cách biểu diễn của nó.

Tệp ▸ Nhập (Ctrl+I) rồi chọn:

  • một tệp .smithy (ngôn ngữ mô hình hóa);
  • hoặc AST JSON do smithy build tạo ra.

Cả hai đều quy về cùng một mô hình nội bộ.

Phần tửRestorm biến nó thành gì
Mỗi service / resourceMột thư mục
Mỗi thao tác mang @httpMột yêu cầu HTTP
@httpLabelMột tham số đường dẫn
@httpQueryMột tham số truy vấn
@httpHeaderMột header
Tài liệu và kiểuTài liệu API và các kiểu liệt kê

Giới hạn (phiên bản 1 của phần nhập)

Section titled “Giới hạn (phiên bản 1 của phần nhập)”
  • Một thao tác không có trait @http thì chỉ mang tính tư liệu: nó xuất hiện trong tài liệu API nhưng không tạo ra yêu cầu nào.
  • Phần xác thực SigV4 không được đấu nối sẵn: hãy cấu hình nó bằng tay.
  • Các liên kết giao thức không phải REST (awsJson1_1, awsQuery…) không được mô hình hóa.
  • Danh sách, từ điển và union không phải là những dạng hạng nhất.
  • Các trait kiểm tra hợp lệ (@pattern, @length, @paginated, @readonly…) bị bỏ qua một cách âm thầm.
  • Các bài kiểm thử giao thức của Smithy bị bỏ qua.

Smithy nằm trong số các định dạng đồng bộ lại được. Xem Cập nhật từ nguồn.