Giới thiệu Trình xem Swagger / OpenAPI — Hướng dẫn chi tiết
OpenAPI Viewer là công cụ đọc tài liệu phía client giúp kiểm tra và xem xét các API contract RESTful. Công cụ kết xuất trực tiếp các đặc tả Swagger 2.0 và OpenAPI 3.0 / 3.1 ở định dạng JSON hoặc YAML mà không cần cài đặt Swagger UI cục bộ hay phụ thuộc vào dịch vụ đám mây.
Giao diện hiển thị thanh điều hướng bên trực quan được phân nhóm rõ ràng cho tất cả các endpoint, thể hiện đầy đủ đường dẫn (paths), phương thức HTTP (GET, POST, PUT, DELETE), tham số header, chuỗi truy vấn (query strings), phần thân yêu cầu (request bodies) có cấu trúc, mã phản hồi HTTP và lược đồ dữ liệu (data schemas).
Tính năng và khả năng nổi bật
- Hỗ trợ đầy đủ các đặc tả Swagger 2.0 và OpenAPI 3.0 / 3.1 ở định dạng JSON và YAML
- Thanh điều hướng tương tác phân loại endpoint, phương thức HTTP và mã trạng thái trực quan
- Phân giải tham chiếu `$ref` chuyên sâu hiển thị các mô hình dữ liệu lồng nhau và ràng buộc thuộc tính
- Phân tích cú pháp 100% offline phía client, bảo đảm an toàn tuyệt đối cho các API contract nội bộ của doanh nghiệp
Cách sử dụng
- 1
Dán nội dung `swagger.json` hoặc `openapi.yaml`, hoặc tải trực tiếp tệp đặc tả lên.
- 2
Duyệt qua tài liệu API có cấu trúc được kết xuất trong trình xem tương tác.
- 3
Mở rộng bất kỳ endpoint nào để kiểm tra request header, schema của request payload và các mẫu dữ liệu phản hồi (response samples).
Trường hợp sử dụng phổ biến
- → Kiểm tra và đánh giá định nghĩa API backend mà không cần dựng máy chủ Swagger UI chuyên dụng
- → Kiểm tra tính hợp lệ của các đặc tả OpenAPI tự viết để phát hiện con trỏ `$ref` không hợp lệ
- → Cung cấp tài liệu tham khảo schema chính xác cho kỹ sư frontend trong quá trình tích hợp API
Công cụ liên quan
Tạo thẻ Meta SEO & OpenGraph
Tạo bộ thẻ meta chuẩn cho SEO, OpenGraph (Facebook) và Twitter Card với trình xem trước trực quan.
Tạo tệp .gitignore
Tạo tệp .gitignore hoàn chỉnh cho Node.js, Python, Java, Go, Rust, macOS, Windows và IDE.
Tạo giấy phép mã nguồn mở
Chọn và tạo văn bản giấy phép mã nguồn mở phổ biến (MIT, Apache 2.0, GPL 3.0, BSD) với thông tin bản quyền.
Tạo tài liệu README.md
Tạo tệp tài liệu README.md chuyên nghiệp cho dự án với các huy hiệu (Badges), hướng dẫn cài đặt và cấu trúc mã nguồn.
Soạn thảo Conventional Commits
Trình soạn thảo thông điệp commit chuẩn hóa theo quy ước Conventional Commits (feat, fix, docs, chore).
Tính toán phiên bản SemVer
Phân tích, so sánh và kiểm tra quy tắc phạm vi phiên bản phần mềm theo tiêu chuẩn Semantic Versioning.
Câu hỏi thường gặp và quyền riêng tư
Công cụ này có thể đọc trực tiếp các tệp đặc tả YAML không?
Có. Trình phân tích cú pháp YAML tích hợp sẵn có thể xử lý cả tệp đặc tả API contract định dạng `.yaml` và `.json` hoàn toàn trong trình duyệt.
Tài liệu đặc tả API nội bộ của tôi có bị tải lên máy chủ bên ngoài không?
Không. Toàn bộ quá trình phân tích tài liệu và kết xuất schema đều thực thi hoàn toàn trong bộ nhớ trình duyệt cục bộ của bạn.