OpenAPI Trình xem tài liệu
Xem và kiểm tra tĩnh OpenAPI 3.0/3.1 JSON hoặc YAML tài liệu ngay trên máy, không gửi yêu cầu mẫu.
Cách sử dụng trình xem tài liệu OpenAPI
OpenAPI Trình xem tài liệu chỉ xử lý dữ liệu đầu vào trong trình duyệt hiện tại, không tải lên, kết nối mạng hoặc lưu dữ liệu người dùng.
Nội dung nhập vào
Dán hoặc tải OpenAPI 3.0/3.1 JSON/YAML tài liệu.
Chọn phương thức xử lý
Duyệt các đường dẫn, thao tác, tham số, nội dung yêu cầu, phản hồi và tham chiếu cục bộ, đồng thời xem các vấn đề tĩnh.
Kiểm tra và xuất
Sao chép tóm tắt tài liệu hoặc xuất kết quả kiểm tra, không thực thi bất kỳ yêu cầu API nào.
Các hạn chế và lưu ý
- Chỉ phân tích tài liệu cục bộ và $ref cục bộ; tham chiếu từ xa và thực thi yêu cầu đều bị cấm.
- Trình xem không phải là trình xác thực đầy đủ cho đặc tả OpenAPI, cũng không chứng minh giao diện có thể sử dụng trên thực tế.
- Công cụ chỉ cung cấp kết quả xử lý hỗ trợ cục bộ; các cấu hình quan trọng, khóa bí mật, tài liệu và nội dung phát hành vẫn cần được rà soát trong môi trường đích.
Câu hỏi thường gặp
Dữ liệu đầu vào có được tải lên máy chủ không?
Không. Trang chỉ sử dụng bộ nhớ trình duyệt, tệp cục bộ API và các tài nguyên cục bộ đã được cung cấp cùng trang web.
Công cụ có gọi giao diện của tôi theo tài liệu không?
Không. Công cụ chỉ tạo cây tài liệu cục bộ và kết quả kiểm tra tĩnh, không tạo yêu cầu mạng.
Tại sao kết quả vẫn cần được kiểm tra thủ công？
Cú pháp biên, quy chuẩn khu vực, trình đọc bên thứ ba và môi trường chạy mục tiêu có thể khác nhau; công cụ không thay thế bước kiểm tra cuối cùng.