Tôi đang làm việc trên một RestAPI bằng cách sử dụng Express.js và tôi tự hỏi liệu có cách nào để tạo tài liệu API cho phép người dùng xem định nghĩa API hay không thậm chí có thể thử gọi API?Trình tạo tài liệu REST API của Node.js hoặc Express.js
Swagger là một dự án tuyệt vời để tự động tạo tài liệu API. Nó bao gồm một mô-đun Express.
gì bạn đang tìm kiếm là một máy phát tài liệu hướng dẫn JavaScript tốt. Tôi tìm thấy một phong nha ở đây http://apidocjs.com/example/. Điều này sẽ cho phép bạn sử dụng Express như op đã hỏi.
Chuyển đổi không dành cho tài liệu, để tạo API. Vì vậy, bạn sẽ cần phải tìm hiểu một hệ thống đầy đủ để có được tính năng đó.
Tôi tìm thấy một vài chi tiết ở đây mà tôi đã không hoàn toàn nhìn vào nhưng mà có vẻ đầy hứa hẹn:
docco here JSDoc here và an article on Documentor for Node
Cảm ơn @dankohn. Tôi đang kiểm tra nó. –
Tự động tạo các tùy chọn này có dựa trên các tuyến đường được định cấu hình trong express không? – lostintranslation
@lostintranslation AFAIK họ không. Tài liệu hướng dẫn được lưu trong tệp yml. – BillyTom