Phát hiện vấn đề trong một API đã nhập

Khi bạn nhập một API (OpenAPI, Swagger và các định dạng được hỗ trợ khác), Restorm giữ tài liệu có cấu trúc của API trên thư mục biến của nó. Ngay sau khi nhập — và mỗi khi bạn mở lại tệp — Restorm âm thầm chiếu tài liệu đó thành một thiết kế và chạy cùng một quy trình kiểm tra mà trình thiết kế API áp dụng, hoàn toàn ở chế độ nền. Nó không bao giờ chặn quá trình nhập và không bao giờ động đến những gì bạn đang làm.

Nếu không tìm thấy gì, bạn sẽ không thấy gì. Nếu tìm thấy các vấn đề về cấu trúc, nó sẽ chỉ cho bạn ở hai nơi.

Dấu “!” trên thanh bên

Thư mục biến chứa API bị gắn cờ hiển thị một dấu “!” nhỏ ở bên phải hàng của nó. Đó là tín hiệu thoáng qua cho biết thiết kế của API này có điều gì đó đáng xem — và nó tự biến mất khi API sạch trở lại (sau khi nhập lại hoặc một bản cập nhật API khắc phục điều đó).

Tab “Vấn đề”

Mở thư mục biến và nó sẽ có thêm một tab Vấn đề. Tab này chỉ xuất hiện khi phát hiện được vấn đề — một API sạch sẽ không bao giờ hiển thị nó.

Tab Vấn đề của thư mục biến của một API đã nhập: một khung cảnh báo, rồi các vấn đề được nhóm theo loại — “Nhiều route trả lời cùng một phương thức và đường dẫn”, “Một số route không khai báo phản hồi nào”, “Một số route nằm trên một đường dẫn mà máy chủ thiết kế dành riêng” — mỗi loại liệt kê các route chính xác mà nó ảnh hưởng, một route được mở rộng để hiển thị tài liệu của route đó

Các vấn đề được nhóm theo loại, nên hai mươi route trùng lặp hiển thị thành một dòng kèm số đếm thay vì hai mươi mục riêng biệt. Dưới mỗi loại, Restorm liệt kê các thực thể chính xác liên quan — một route hiển thị động từ HTTP và đường dẫn thực của nó, và mở rộng đến tài liệu của route đó để bạn có thể xem nó khai báo những gì mà không cần rời khỏi tab.

Các bước kiểm tra phản ánh của trình thiết kế API, nên các loại vấn đề bạn có thể gặp bao gồm:

route trùng lặp — hai route trả lời cùng một phương thức và đường dẫn;
phản hồi bị thiếu — một route không khai báo phản hồi nào cả;
đường dẫn dành riêng — một route nằm trên một đường dẫn mà Mock Server dành riêng (/swagger.json, /graphql, …), sẽ không bao giờ trả lời;
vấn đề về ràng buộc — một mẫu không hợp lệ, hoặc một giá trị tối thiểu lớn hơn giá trị tối đa của nó.

Danh sách chỉ để đọc: nó cho bạn biết cần sửa gì, và bạn sửa tại nguồn (nhập lại một đặc tả đã chỉnh sửa, hoặc chỉnh sửa API). Nó được tính lại vào các sự kiện làm thay đổi một API — mở tệp, nhập, cập nhật API — chứ không phải mỗi lần gõ phím.