Scalar

Scalar là một nền tảng để xây dựng tài liệu API trông chuyên nghiệp và hoạt động mượt mà. Bạn cung cấp tài liệu OpenAPI của mình, và Scalar sẽ biến nó thành các trang dễ đọc với các ví dụ và công cụ kiểm thử tích hợp sẵn.

Nền tảng cung cấp nhiều sản phẩm hoạt động cùng nhau. API Reference hiển thị tài liệu của bạn trong một bố cục sạch sẽ. API Client cho phép các nhà phát triển kiểm thử các điểm cuối trực tiếp. Nền tảng cũng bao gồm các công cụ quản lý nhiều phiên bản tài liệu API và đồng bộ với GitHub.

Scalar hoàn toàn mã nguồn mở, nghĩa là mã nguồn được công khai và miễn phí sử dụng. Bạn có thể tự lưu trữ hoặc sử dụng dịch vụ đám mây của họ. Gói miễn phí bao gồm các tính năng cơ bản, trong khi các gói trả phí bổ sung công cụ cộng tác, tên miền tùy chỉnh và hỗ trợ tốt hơn.

Sử dụng Scalar rất đơn giản và không yêu cầu cài đặt phức tạp. Dưới đây là các bước để bắt đầu:

• Truy cập trang web Scalar và tạo một tài khoản miễn phí để lưu công việc của bạn. Bạn sẽ nhận được một tên miền phụ miễn phí như yourname.apidocumentation.com.

• Tải lên tài liệu OpenAPI của bạn bằng cách dán URL, tải tệp lên hoặc kết nối với GitHub. Scalar hỗ trợ cả định dạng JSON và YAML.

• Chọn một chủ đề và tùy chỉnh màu sắc để phù hợp với thương hiệu của bạn. Bạn có thể thêm CSS tùy chỉnh nếu muốn kiểm soát nhiều hơn về thiết kế.

• Viết thêm các hướng dẫn bằng trình soạn thảo. Những trang này giải thích các khái niệm vượt ra ngoài các trang tham khảo tự động.

• Kiểm tra các điểm cuối API của bạn bằng trình khách tích hợp sẵn. Nhấp vào bất kỳ điểm cuối nào, thêm tham số và gửi yêu cầu để xem phản hồi thực tế.

• Chia sẻ tài liệu của bạn với nhóm hoặc công khai. Bạn có thể thiết lập quyền để kiểm soát ai có thể chỉnh sửa hoặc xem.

• Tài liệu API đẹp mắt từ các tệp OpenAPI

• Kiểm thử tích hợp với client API

• Tích hợp GitHub và đồng bộ tự động

• Tên miền và giao diện tùy chỉnh

• Tích hợp framework cho tất cả các nền tảng chính

• Tìm kiếm được hỗ trợ bởi TypeSense

• Hỗ trợ nhiều phiên bản API

• Hướng dẫn Markdown và MDX

• Công cụ hợp tác nhóm

• Mã nguồn mở và có thể tự lưu trữ

• Bao gồm tên miền phụ miễn phí

• Hỗ trợ CSS và JavaScript tùy chỉnh