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 buildtạo ra.
Cả hai đều quy về cùng một mô hình nội bộ.
Những gì được nhập
Section titled “Những gì được nhập”| Phần tử | Restorm biến nó thành gì |
|---|---|
Mỗi service / resource | Một thư mục |
Mỗi thao tác mang @http | Một yêu cầu HTTP |
@httpLabel | Một tham số đường dẫn |
@httpQuery | Một tham số truy vấn |
@httpHeader | Một header |
| Tài liệu và kiểu | Tà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
@httpthì 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.
Cập nhật
Section titled “Cập nhật”Smithy nằm trong số các định dạng đồng bộ lại được. Xem Cập nhật từ nguồn.