Redocly xây dựng danh tiếng của mình dựa trên Redoc, trình kết xuất mã nguồn mở đã biến các thông số kỹ thuật OpenAPI thành tài liệu tham khảo ba bảng sạch sẽ. Nền tảng trả phí bổ sung nhiều lớp khác: cổng thông tin được lưu trữ, Redocly CLI để linting và bundling, cùng với dòng sản phẩm mới hơn là Realm, Revel và Reef.
Vậy tại sao các nhóm lại tìm kiếm một giải pháp thay thế Redocly? Ba lý do sau đây thường xuyên được nhắc đến:
- Giá cả tăng theo số lượng trang và dự án. Gói Pro bắt đầu từ 50 đô la mỗi tháng cho một dự án và 100 trang. Mỗi trang bổ sung tốn 0,12 đô la mỗi tháng, và mỗi dự án bổ sung thêm 49 đô la mỗi tháng. Các nhóm có nhiều API hoặc thông số kỹ thuật lớn sẽ thấy hóa đơn tăng lên nhanh chóng.
- Chỉ dừng lại ở tài liệu. Redocly chỉ hiển thị và xuất bản thông số kỹ thuật của bạn. Nó không giúp bạn thiết kế API, kiểm thử, tạo mock, hoặc giữ tài liệu đồng bộ với những gì backend cung cấp. Bạn vẫn cần hai hoặc ba công cụ khác cho những việc đó.
- Con đường mã nguồn mở còn nhiều lỗ hổng. Redoc miễn phí chỉ tạo ra một tài liệu tham khảo chỉ đọc. Bảng điều khiển "Thử ngay", tìm kiếm trên nhiều API và kiểm soát quyền truy cập đều nằm sau các sản phẩm trả phí.
Nếu bất kỳ điều nào trong số đó phù hợp với tình huống của bạn, một trong bảy công cụ dưới đây sẽ phù hợp hơn. Danh sách bao gồm các nền tảng tất cả trong một, dịch vụ tài liệu dưới dạng mã (docs-as-code) và các tùy chọn mã nguồn mở, để bạn có thể chọn theo quy trình làm việc thay vì trang tiếp thị.
1. Apidog
Apidog có cách tiếp cận trái ngược với Redocly: thay vì lập tài liệu cho một API sau khi nó đã tồn tại, Apidog bao quát toàn bộ vòng đời trong một không gian làm việc. Bạn thiết kế thông số kỹ thuật trực quan hoặc trong OpenAPI, gỡ lỗi các điểm cuối, tạo kịch bản kiểm thử, khởi tạo máy chủ mock và xuất bản tài liệu tương tác từ cùng một nguồn đáng tin cậy.
Phần cuối cùng đó rất quan trọng đối với bất kỳ ai rời bỏ Redocly. Các tài liệu mà Apidog xuất bản không phải là một tạo phẩm riêng biệt mà bạn phải duy trì; chúng tự động tạo lại bất cứ khi nào thông số kỹ thuật thay đổi. Mỗi trang điểm cuối đi kèm với một bảng điều khiển "Thử ngay" hoạt động được, các mẫu mã trong hơn 30 ngôn ngữ và tên miền tùy chỉnh của riêng bạn. So sánh điều đó với Redoc, nơi mà chỉ riêng bảng điều khiển thử nghiệm đã yêu cầu một gói trả phí.
Điểm vượt trội so với Redocly:
- Gói miễn phí bao gồm tài liệu được lưu trữ, bảng điều khiển thử nghiệm và các dự án không giới hạn; không có giá theo trang nào cả
- Kiểm thử, tạo mock và gỡ lỗi API được tích hợp sẵn, vì vậy tài liệu không bao giờ bị lệch khỏi hành vi API thực tế
- Chỉnh sửa thông số kỹ thuật trực tuyến với hỗ trợ nhánh, thay vì quy trình làm việc chỉ sử dụng CLI và Git
- Cộng tác nhóm với vai trò và đồng bộ hóa thời gian thực mà không mất thêm chi phí
Trường hợp Redocly vẫn thắng thế: nếu bạn muốn một quy trình docs-as-code với các quy tắc linting CI chặt chẽ và không gì khác, Redocly CLI là một công cụ chuyên biệt cho điều đó. Để có phân tích chi tiết hơn từng tính năng, hãy xem so sánh Apidog và Redocly của chúng tôi.
Giá cả: miễn phí cho hầu hết các nhóm; các gói trả phí bổ sung các tính năng doanh nghiệp như SSO.
Tải Apidog và nhập thông số kỹ thuật OpenAPI hiện có của bạn; tài liệu sẽ được hiển thị trong khoảng một phút.
2. Scalar
Scalar là công cụ kế nhiệm mã nguồn mở gần nhất với lời hứa ban đầu của Redoc: chỉ cần thả một tệp OpenAPI vào, bạn sẽ nhận được một tài liệu tham khảo được trau chuốt. Sự khác biệt là kết quả trông hiện đại hơn chứ không giống như năm 2018, và client tương tác là miễn phí. Gói mã nguồn mở này có hơn 100 nghìn lượt tải xuống npm hàng tuần và tích hợp trực tiếp với Fastify, Hono, Express và .NET.
Điểm vượt trội so với Redocly:
- Môi trường thử nghiệm "try-it" là miễn phí và mã nguồn mở; với Redoc, đó là một tính năng trả phí
- Gói Pro được lưu trữ có giá 24 đô la mỗi tháng, so với 50 đô la của Redocly cộng thêm phí theo trang
- Các tích hợp khung tốt nhất khiến nó chỉ cần một lời gọi
app.use()trong backend của bạn
Lưu ý: Scalar tập trung vào tài liệu tham khảo API. Các hướng dẫn dài, quy trình làm việc phiên bản hóa và kiểm soát truy cập doanh nghiệp ít được phát triển hơn so với nền tảng Realm của Redocly. Hướng dẫn Scalar cho người mới bắt đầu của chúng tôi cho thấy quy trình làm việc thực tế.
Giá cả: mã nguồn mở miễn phí; gói Pro được lưu trữ là 24 đô la mỗi tháng.
3. Mintlify
Mintlify nhắm đến các nhóm muốn tài liệu của họ trông giống như của Stripe. Nó dựa trên MDX, đồng bộ hóa với Git và đi kèm với các tính năng AI như một trợ lý trả lời các câu hỏi từ tài liệu của bạn. Các tham chiếu OpenAPI được hiển thị cùng với các hướng dẫn, nhật ký thay đổi và hướng dẫn trong một trang web duy nhất.
Điểm vượt trội so với Redocly: chất lượng thiết kế ngay từ đầu và các công cụ nội dung dài mạnh mẽ hơn nhiều. Nếu tài liệu của bạn gồm 30% tham chiếu API và 70% hướng dẫn, cấu trúc của Mintlify phù hợp hơn một công cụ ưu tiên tham chiếu.
Lưu ý: gói Pro có giá 250 đô la trở lên mỗi tháng với năm chỗ biên tập, khiến nó trở thành một trong những lựa chọn đắt tiền ở đây; chuyển từ Redocly vì lý do chi phí sẽ dẫn bạn đến các lựa chọn khác. Gói Hobby miễn phí hoạt động tốt cho các dự án phụ.
4. ReadMe
ReadMe là nền tảng trung tâm phát triển kỳ cựu. Ngoài việc hiển thị thông số kỹ thuật OpenAPI của bạn, nó còn bổ sung những thứ mà Redocly không cố gắng thực hiện: nhật ký API thời gian thực bên trong tài liệu, để người dùng thấy các yêu cầu gần đây của chính họ, cộng với các số liệu về những điểm cuối gây khó hiểu cho người dùng.
Điểm vượt trội so với Redocly: trải nghiệm phát triển cá nhân hóa. Khi người dùng dán khóa API của họ, mọi mẫu mã đều cập nhật với thông tin xác thực thực của họ và bộ phận hỗ trợ có thể xem các cuộc gọi thất bại thực tế của họ.
Lưu ý: tùy chỉnh ngoài chủ đề tích hợp sẵn yêu cầu gói Business của họ với giá 399 đô la mỗi tháng, và trải nghiệm chỉnh sửa là ưu tiên web hơn là docs-as-code. Các nhóm yêu thích quy trình làm việc tập trung vào Git của Redocly CLI có thể thấy quy trình làm việc của ReadMe lỏng lẻo. Chúng tôi đã so sánh trực tiếp các nền tảng tài liệu trong bài Mintlify vs Scalar vs Bump vs ReadMe vs Redocly.
Giá cả: gói miễn phí; các gói trả phí từ 99 đô la mỗi tháng.
5. Stoplight
Stoplight trùng lặp với Redocly nhiều hơn bất kỳ công cụ nào khác trong danh sách này: cả hai đều cung cấp tính năng linting thông số kỹ thuật, hướng dẫn phong cách và tài liệu được lưu trữ cho các nhóm ưu tiên thiết kế. Stoplight bổ sung trình chỉnh sửa OpenAPI trực quan và máy chủ mock tích hợp sẵn thông qua Prism, điều mà Redocly không có.
Điểm vượt trội so với Redocly: công cụ thiết kế trực quan giúp giảm rào cản cho các đồng đội không viết YAML, và tính năng Prism mocking có nghĩa là công việc frontend có thể bắt đầu trước khi backend hoàn thành.
Lưu ý: kể từ khi SmartBear mua lại, tương lai độc lập của Stoplight không rõ ràng; một số tính năng đang được hợp nhất vào danh mục SwaggerHub, và các nhóm đã di chuyển các thông số kỹ thuật của họ ra ngoài. Hãy đánh giá với rủi ro lộ trình đó trong tâm trí.
Giá cả: gói miễn phí; các gói trả phí theo người dùng.
6. SwaggerHub
SwaggerHub là nơi lưu trữ các công cụ Swagger của SmartBear. Đối với các tổ chức đang chuẩn hóa hàng trăm thông số kỹ thuật OpenAPI với các quy tắc quản trị, phiên bản hóa và một danh mục trung tâm, đây là lựa chọn đương nhiệm.
Điểm vượt trội so với Redocly: chuẩn hóa toàn tổ chức, tái sử dụng miền trên các thông số kỹ thuật và tích hợp với bộ công cụ kiểm thử SmartBear rộng lớn hơn. Các nhóm mua sắm doanh nghiệp đã quen thuộc với SmartBear.
Lưu ý: các tài liệu được hiển thị có chức năng nhưng đã cũ so với đầu ra của Redoc hoặc Scalar, và giá theo nhà thiết kế cộng dồn lại. Trải nghiệm chỉnh sửa vẫn giống như trình chỉnh sửa Swagger cổ điển.
7. Bump.sh
Bump.sh làm một điều mà Redocly không làm: tự động tạo nhật ký thay đổi API. Đẩy một phiên bản thông số kỹ thuật mới từ CI và nó sẽ so sánh hợp đồng, làm nổi bật các thay đổi gây phá vỡ và thông báo cho người tiêu dùng. Các tài liệu được lưu trữ sạch sẽ và xử lý cả API REST và API hướng sự kiện (AsyncAPI).
Điểm vượt trội so với Redocly: quản lý thay đổi. Nếu vấn đề chính của bạn là người tiêu dùng bị bất ngờ bởi các thay đổi API, Bump.sh giải quyết trực tiếp vấn đề đó.
Lưu ý: nó được thiết kế khá hạn chế. Không có bộ công cụ linting, không có công cụ thiết kế, không có kiểm thử. Hầu hết các nhóm kết hợp nó với một công cụ khác, điều này có thể tái tạo sự phức tạp của nhiều công cụ mà bạn đang cố gắng thoát khỏi.
Cách chọn
Hãy chọn công cụ phù hợp với công việc mà bạn đang cần:
| Bạn cần | Chọn |
|---|---|
| Tài liệu cùng với thiết kế, kiểm thử và tạo mock trong một công cụ | Apidog |
| Tham chiếu mã nguồn mở, miễn phí với tính năng thử nghiệm | Scalar |
| Trang tài liệu đẹp, nặng về hướng dẫn | Mintlify |
| Trung tâm phát triển với nhật ký API cấp người dùng | ReadMe |
| Thiết kế và quản trị OpenAPI trực quan | Stoplight (với lưu ý về lộ trình) |
| Danh mục thông số kỹ thuật doanh nghiệp | SwaggerHub |
| Nhật ký thay đổi tự động và cảnh báo khác biệt | Bump.sh |
Nếu giá theo trang khiến bạn tìm đến đây, Apidog và Scalar loại bỏ hoàn toàn hạn chế đó. Nếu phạm vi chỉ có tài liệu là vấn đề, chỉ Apidog thay thế các công cụ kiểm thử và tạo mock nằm cạnh Redocly trong ngăn xếp của bạn. Để có cái nhìn tổng quan rộng hơn ngoài các lựa chọn thay thế Redocly, tổng hợp của chúng tôi về 10 công cụ tài liệu API REST tốt nhất bao gồm toàn bộ lĩnh vực.
Trước khi chuyển đổi: danh sách kiểm tra 5 điểm
Việc chuyển đổi nền tảng tài liệu có rủi ro thấp so với hầu hết các lần di chuyển, nhưng một vài chi tiết có thể gây khó khăn cho các nhóm bỏ qua chúng:
- Xác nhận hỗ trợ phiên bản OpenAPI. Xuất thông số kỹ thuật của bạn và xác thực nó trước; một tệp 3.0 hoặc 3.1 sạch có thể nhập vào bất cứ đâu, nhưng các tiện ích mở rộng của nhà cung cấp như
x-tagGroupshoặc đánh dấu riêng của Redocly có thể cần được dịch. Hãy chạy nó qua một trong các công cụ xác thực OpenAPI trước khi nhập. - Lập kế hoạch chuyển hướng URL. Cấu trúc URL của Redocly sẽ không khớp với cấu trúc của máy chủ mới của bạn. Ánh xạ các URL tài liệu cũ sang các URL mới bằng chuyển hướng 301, nếu không bạn sẽ mất thứ hạng tìm kiếm mà tài liệu đã đạt được.
- Giữ nguyên quy trình linting CI của bạn. Nếu
redocly lintđang chạy trong pipeline của bạn hôm nay, không có gì buộc bạn phải bỏ nó. CLI vẫn hữu ích bất kể tài liệu được hiển thị ở đâu. - Kiểm tra bảng điều khiển thử nghiệm với xác thực của bạn. Các luồng OAuth, tiêu đề khóa API và cài đặt CORS hoạt động khác nhau trên các bảng điều khiển. Xác minh một cuộc gọi được xác thực thực sự hoạt động trước khi công bố tài liệu mới.
- Kiểm tra xử lý tên miền tùy chỉnh và SSL. Các gói miễn phí khác nhau ở đây: Apidog bao gồm các tên miền tùy chỉnh, Scalar giới hạn chúng ở gói Pro với 24 đô la mỗi tháng, và các gói khác thì khác. Xác nhận gói bạn định sử dụng bao gồm cài đặt tên miền của bạn.
Một buổi làm việc chuyên sâu nửa ngày sẽ bao gồm tất cả năm điểm này. Nhập thông số kỹ thuật của bạn vào ứng cử viên hàng đầu, kết nối một tên miền thử nghiệm và thực hiện một cuộc gọi thử nghiệm được xác thực từ đầu đến cuối.
Câu hỏi thường gặp
Redoc có còn miễn phí không? Có. Trình kết xuất Redoc mã nguồn mở vẫn được cấp phép MIT và miễn phí. Các giới hạn thể hiện ở những gì nó bỏ qua: không có bảng điều khiển thử nghiệm, không tìm kiếm đa API, không lưu trữ. Các công cụ như Scalar và Apidog bao gồm những tính năng đó miễn phí.
Giải pháp thay thế Redocly nào rẻ nhất có bảng điều khiển thử nghiệm? Gói mã nguồn mở của Scalar và gói miễn phí của Apidog đều bao gồm bảng điều khiển tương tác mà không mất phí. Việc lưu trữ tài liệu tương tác với bảng điều khiển thử nghiệm không còn yêu cầu gói trả phí ở bất kỳ đâu trong ngăn xếp.
Tôi có thể giữ quy trình linting Redocly CLI của mình và chuyển đổi máy chủ tài liệu không? Có. Redocly CLI là mã nguồn mở và hoạt động như một công cụ linting độc lập trong CI. Nhiều nhóm sử dụng nó để linting trong khi xuất bản tài liệu thông qua Apidog, Scalar hoặc Bump.sh.
Giải pháp thay thế nào xử lý tốt nhất docs-as-code với Git? Mintlify, Bump.sh và Apidog đều đồng bộ hóa từ các kho lưu trữ Git. Xem so sánh của chúng tôi về các công cụ tài liệu API với tích hợp Git để biết chi tiết thiết lập cho từng công cụ.
Cách nhanh nhất để kiểm thử bất kỳ công cụ nào trong số này là với thông số kỹ thuật của riêng bạn, không phải bản demo của nhà cung cấp. Xuất tệp OpenAPI của bạn, nhập nó vào Apidog hoặc bất kỳ công cụ nào phù hợp với cột của bạn ở trên, và đánh giá kết quả trên API thực của bạn.