Trình xem và kiểm thử API OpenAPI

TL;DR

Scalar là bộ công cụ API mã nguồn mở, gồm API Reference (hiển thị tài liệu từ OpenAPI/Swagger) và API Client (thay thế Postman). Hỗ trợ 30+ framework như Next.js, FastAPI, Laravel. Dùng được cả online lẫn offline.

Nói đơn giản: Dev nào xài API thì dùng cái này vừa viết tài liệu tự động vừa test API, miễn phí hoàn toàn.

Bài này dành cho ai?

1. Backend Developer

Vấn đề: Viết tài liệu API tay mất thời gian, ai cũng khác format Khi nào cần: Khi build API bằng FastAPI, Express, Laravel… Được gì: Tài liệu tự generate từ code, khách hàng hoặc teammate xài được ngay

2. Frontend Developer

Vấn đề: Phải cài Postman, Insomnia để test API, hay phải hỏi backend Khi nào cần: Khi cần xem API docs và test nhanh không cần cài app Được gì: Vào link là thấy docs + test được luôn, khôg cần setup gì

3. Dev muốn thay thế công cụ trả phí

Vấn đề: Postman có tính năng hay nhưng mất phí, team đông thì tốn Khi nào cần: Khi tìm giải pháp miễn phí cho cả team Được gì: Công cụ tương tự, mã nguồn mở, không giới hạn người dùng

Các điểm chính

1. Tài liệu API tự động từ OpenAPI Thay vì viết tài liệu tay, cứ khai báo API theo chuẩn OpenAPI là Scalar tự render ra trang docs đẹp. Có cả chức năng test API ngay trên docs luôn. → Làm gì: Thêm OpenAPI spec vào project, dùng Scalar để render docs

2. API Client miễn phí, hỗ trợ OpenAPI Scalar Client là Postman alternative, đọc được OpenAPI spec và tự điền request parameters. Hỗ trợ environment variables, dynamic parameters. → Làm gì: Download về xài thay Postman nếu team muốn tiết kiệm chi phí

3. Tích hợp sẵn 30+ framework Next.js, Nuxt, Astro, FastAPI, Express, Laravel, Django, Spring Boot… Các framework này còn chọn Scalar làm docs UI mặc định luôn. → Làm gì: Xem danh sách integrations phù hợp với stack đang xài

4. Có phiên bản online và offline Vừa chạy được trên browser (client.scalar.com), vừa tải về máy dùng offline. Có cả managed hosting miễn phí nếu muốn deploy lên cloud. → Làm gì: Thử online trước, nếu thích thì tải desktop app về

5. Một file HTML là có docs Chỉ cần thêm đoạn script ngắn vào HTML là có trang API reference chạy được. Không cần server, không cần build process. → Làm gì: Copy đoạn code sample trong readme, chạy thử 1 phút là xong

Quick Start

1. Tạo API docs trong 1 phút — Tạo file HTML, thêm script <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>, trỏ tới file OpenAPI JSON là có docs chạy được

2. Test thử API Client — Vào client.scalar.com, upload OpenAPI spec hoặc import từ URL, bắt đầu test request