Sau khi gửi thành công một yêu cầu API, Apidog có thể tự động phân tích dữ liệu yêu cầu và phản hồi để tạo một đặc tả endpoint hoàn chỉnh. Tính năng mạnh mẽ này giúp tiết kiệm thời gian và bảo đảm tài liệu API của bạn phản ánh chính xác hành vi thực tế.Phân tích yêu cầu thành đặc tả Endpoint#
Một yêu cầu đã được gửi thành công, nếu chưa được định nghĩa, có thể được Apidog tự động phân tích thành một đặc tả endpoint.Sau khi gửi yêu cầu, bạn có thể nhấp vào menu thả xuống bên cạnh nút Save và chọn Save as endpoint để lưu yêu cầu đó dưới dạng đặc tả endpoint.Khi bạn lưu một yêu cầu dưới dạng endpoint, Apidog sẽ trích xuất thông minh các thông tin sau:Tham số yêu cầu: Các loại params của yêu cầu hiện tại sẽ được xem là đặc tả tham số yêu cầu trong endpoint, và các giá trị tham số hiện tại sẽ được xem là giá trị ví dụ cho các tham số yêu cầu.
Schema phản hồi: Cấu trúc dữ liệu phản hồi của yêu cầu hiện tại sẽ được phân tích thành đặc tả phản hồi, và các giá trị phản hồi sẽ được xem là ví dụ phản hồi.
Tính năng này đặc biệt hữu ích khi làm việc với các API hiện có hoặc khi bạn muốn nhanh chóng lập tài liệu cho một API dựa trên dữ liệu yêu cầu/phản hồi thực tế thay vì định nghĩa schema theo cách thủ công.
Trích xuất phản hồi#
Apidog hỗ trợ trích xuất phản hồi vào đặc tả endpoint, có thể được trích xuất dưới dạng schema phản hồi hoặc ví dụ phản hồi.Sự linh hoạt này cho phép bạn chọn cập nhật định nghĩa schema của endpoint hoặc chỉ cần thêm một ví dụ phản hồi mới cho mục đích tài liệu và kiểm thử.Việc trích xuất phản hồi dưới dạng schema hữu ích khi cấu trúc API đã thay đổi, trong khi trích xuất dưới dạng ví dụ phù hợp hơn để lập tài liệu cho các kịch bản phản hồi khác nhau (thành công, lỗi, trường hợp biên).
