Trình thiết kế API
Trình thiết kế API cho phép bạn thiết kế một API hoàn chỉnh trực tiếp trong Restorm: bạn mô tả dữ liệu và các tuyến của mình, Restorm lo phần còn lại — nó phục vụ thiết kế của bạn như một máy chủ mock thực thụ, và nó sinh mã cho ứng dụng của bạn từ các template.
Đây là công cụ lý tưởng để khởi động một API trước khi back-end tồn tại: dựng bản mẫu của hợp đồng, cho khách hàng của bạn kiểm thử, và giữ tất cả được quản lý phiên bản trong dự án của bạn.
Một thiết kế, nhiều phần
Section titled “Một thiết kế, nhiều phần”Một thiết kế được tạo như bất kỳ phần tử nào khác: nhấp chuột phải vào một thư mục ▸ Thêm ▸ Thiết kế API. Nó mở trong tab riêng của mình và gom nhiều phần lại, truy cập được từ thanh bên:
| Phần | Dùng để làm gì |
|---|---|
| Mô hình | Các thực thể và thuộc tính của chúng — xem Mô hình, enum và thuộc tính. |
| Enum | Các tập giá trị đóng, tái sử dụng được làm kiểu của thuộc tính. |
| Tuyến | Các điểm truy cập của API, gom theo tài nguyên — xem Tuyến & CRUD. |
| Máy chủ | Phục vụ thiết kế dưới dạng mock, qua HTTP, GraphQL, SOAP, OData hoặc gRPC — xem Phục vụ thiết kế dưới dạng mock. |
| Client | Các yêu cầu sẵn dùng gọi mock đang chạy — xem Client. |
| Tài liệu & Ghi chú | Tài liệu và ghi chú tự do gắn với thiết kế. |
| Mã | Việc sinh mã từ các template của bạn — xem Sinh mã. |
Các thiết lập của thiết kế (tên, giá trị mặc định) mở ra khi nhấp trực tiếp vào nút thiết kế trong thanh bên.
Hành trình điển hình
Section titled “Hành trình điển hình”- Mô tả dữ liệu của bạn — tạo các mô hình và enum, thêm thuộc tính, kiểu và ràng buộc của chúng.
- Định nghĩa các tuyến của bạn — thủ công, hoặc một nhấp với Sinh CRUD từ một mô hình.
- Phục vụ mock — khởi động máy chủ và trỏ ứng dụng hoặc một client vào đó. Cùng một thiết kế được chiếu tự động vào từng giao thức được bật.
- Sinh mã — chọn một hoặc nhiều template (của bạn hoặc những template do Restorm cung cấp) và tạo ra dự án tương ứng.
Mỗi bước được trình bày chi tiết trong các trang của phần này.