Nhập một tài liệu API Blueprint
API Blueprint mô tả một API bằng Markdown mở rộng. Restorm phân tích nó bằng trình phân tích chính thức (Drafter), được biên dịch sang WebAssembly và nhúng sẵn: không cần công cụ bên ngoài nào.
Tệp ▸ Nhập (Ctrl+I) rồi chọn tệp .apib, hoặc dán nội dung bắt đầu bằng
FORMAT: 1A.
Những gì được nhập
Section titled “Những gì được nhập”| Phần tử | Restorm biến nó thành gì |
|---|---|
| Các nhóm tài nguyên | Các thư mục |
| Mỗi chuyển tiếp | Một yêu cầu HTTP |
| Các tham số | Có kiểu |
| URL của máy chủ | URL cơ sở của môi trường |
| Mô tả và mô hình | Tài liệu API |
Nhiều ví dụ cho một chuyển tiếp
Section titled “Nhiều ví dụ cho một chuyển tiếp”Một chuyển tiếp API Blueprint có thể khai báo nhiều cặp + Request /
+ Response. Restorm tạo ra một yêu cầu cho mỗi cặp, kèm một hậu tố chỉ số
(#1, #2…) để phân biệt chúng.