Nhập một tài liệu AsyncAPI
AsyncAPI mô tả các API hướng sự kiện giống như cách OpenAPI mô tả các API REST. Restorm rút ra từ đó các yêu cầu nhắn tin.
Tệp ▸ Nhập (Ctrl+I) rồi chọn tài liệu, ở dạng YAML hoặc JSON.
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 kênh | Một yêu cầu phát và một yêu cầu đăng ký, được gắn nhãn tương ứng |
| Giao thức của máy chủ | Kiểu của yêu cầu được tạo ra (xem bên dưới) |
| Schema của thông điệp | Một tải trọng ví dụ dựng theo schema |
| Mô tả | Tài liệu API |
Các yêu cầu được gom vào một thư mục cho mỗi giao thức.
Ánh xạ giao thức
Section titled “Ánh xạ giao thức”| Giao thức AsyncAPI | Yêu cầu Restorm được tạo ra |
|---|---|
mqtt, mqtts | MQTT, với tiền tố URL mqtt:// |
socketio, socket.io | Socket.IO |
| Tất cả những giao thức còn lại | WebSocket, với tiền tố URL ws:// |
Cập nhật
Section titled “Cập nhật”AsyncAPI nằm trong số các định dạng đồng bộ lại được. Xem Cập nhật từ nguồn.