@powerduck/oas-document
Thành phần tài liệu OpenAPI cho React, sẵn sàng dùng trong môi trường thực tế. Truyền vào tài liệu OAS để có giao diện tài liệu API kiểu Stripe với điều hướng đầu trang, giao diện sáng và tối, cây điều hướng, theo dõi cuộn, khám phá lược đồ và ví dụ mã bằng nhiều ngôn ngữ.
- Tên gói:
@powerduck/oas-document - Phiên bản:
- Giấy phép: MIT
Các thư viện nền tảng: @powerduck/openapi-parser (kiểm tra tính hợp lệ và chuyển đổi tự động), @powerduck/tree (điều hướng), @powerduck/md-editor (hiển thị Markdown), @powerduck/openapi-codegen (tạo mã yêu cầu).
Tính năng
- Tài liệu API tích hợp ngay — Nhận đối tượng đã phân tích cú pháp, chuỗi JSON hoặc chuỗi YAML
- Bố cục kiểu Stripe — Phần đầu trang tùy chỉnh, cây ở thanh bên và chế độ xem thao tác hai cột
- Giao diện sáng và tối — Chuyển đổi ở đầu trang, lựa chọn được lưu vào localStorage
- Tự động chuyển đổi sang OAS 3.2 — Kiểm tra và chuyển đổi qua
@powerduck/openapi-parser - Điều hướng đồng bộ với cuộn — Trình lắng nghe cuộn thụ động kết hợp tìm kiếm nhị phân
- hiển thị Markdown — Mô tả được hiển thị qua
@powerduck/md-editor - Ví dụ mã bằng nhiều ngôn ngữ — Được tạo qua
@powerduck/openapi-codegen - Khám phá lược đồ — Bảng thuộc tính lồng nhau có thể mở rộng và thu gọn
- Bố cục thích ứng — Thanh bên chuyển thành bảng phủ trên thiết bị di động