Tạo tài liệu REST API

Question

Có thư viện nào cung cấp đánh dấu để viết tài liệu REST API không? Tôi đã thấy một số công ty sử dụng mô hình tài liệu tương tự, ví dụ:

http://api.teamlab.com/2.0/

http://www.fullcontact.com/docs/?category=person

Tôi tự hỏi nếu họ đang sử dụng các thư viện hoặc dịch vụ tương tự. Về cơ bản, thư viện sẽ tạo các trang cho điều hướng API, tìm kiếm và hiển thị (giống như YARD cho tài liệu ruby) dựa trên văn bản đánh dấu.

Đây là những gì tôi đã tìm thấy cho đến nay:

• rapi_doc gem. Đây là một số article thảo luận về cách sử dụng.

Answer 1

Bạn chắc chắn nên xem Swagger.

Đây là mã nguồn mở, được hàng trăm API sử dụng và cũng được sử dụng bởi 3scale trong giải pháp Quản lý API dưới tên Active Documents.

Answer 2

Kiểm tra IO/Docs từ Mashery.

Tài liệu I/O Mashery, thế hệ tiếp theo của tài liệu API và thăm dò, cho phép các nhà phát triển thực hiện cuộc gọi API trực tiếp từ tài liệu của bạn. Hãy suy nghĩ tài liệu đáp ứng thử nghiệm và gỡ lỗi, tất cả trong một giao diện tương tác thuận tiện.

Kiểm tra Parse API Docs để biết ví dụ về tài liệu tuyệt vời khác.

Ngoài ra, chúng tôi đã dành rất nhiều thời gian thiết kế FullContact API Docs. Chúng tôi cũng sử dụng số Apigee Live API Console.

Answer 3

Đây là một viên ngọc hữu ích cho api documentaion (Rails4 và Rails5)

ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0.

Rất dễ thiết lập và có trải nghiệm người dùng tốt.