Resteasy - tạo tài liệu REST từ Javadoc và chú thích

Question

Tôi muốn tìm một cách để tạo tài liệu REST API tốt đẹp từ mã java (WADL hoặc HTML) - dựa trên chú thích JAXB, JAX-RS và chú thích java doc (không doclet) xin vui lòng).

Đây là môi trường dự án của tôi

• mùa xuân, không có XML chỉ chú thích của
• Rest-dễ dàng như cung cấp dịch vụ REST của
• JAXB và JAX-RS chú thích
• Mime Type cho API còn lại trong JSON

Answer 1

Hãy thử Enunciate.

Enunciate là công cụ giúp tăng cường đáng kể API dịch vụ web Java của bạn. Thật đơn giản. Bạn phát triển API dịch vụ Web của bạn bằng cách sử dụng các công nghệ Java chuẩn và đính kèm Enunciate vào quá trình xây dựng của bạn. Đột nhiên, API dịch vụ web của bạn tự hào với một số tính năng khá ấn tượng:

• Tài liệu HTML đầy đủ về dịch vụ của bạn, được lấy từ JavaDocs.
• Thư viện phía máy khách (ví dụ: Java, .NET, iPhone, Ruby, Flex, AJAX, GWT, v.v.) dành cho nhà phát triển muốn giao tiếp với API của bạn.
• Interface Tài liệu Định nghĩa (ví dụ WSDL, WADL, XML Schema, vv)
• vv

Answer 2

API trình biên dịch Java cho phép bạn viết mã phân tích nguồn Java và thực hiện quá trình xử lý của riêng bạn.

Dưới đây là một số instructional article, bao gồm thông tin về phân tích cú pháp chú thích.

Tôi đoán rằng bạn có thể trích xuất thông tin thô mà bạn cần bằng cách sử dụng các API này. Tuy nhiên, điều này sẽ mang lại các sự kiện cú pháp - các URL REST và các hành động và các tham số, người dùng cũng sẽ được hưởng lợi từ giải thích bổ sung, mà tác giả dịch vụ có thể (nên?) Cung cấp trong Java Doc.

giải pháp đầy đủ có thể là phân tích cú pháp cả chú thích và tài liệu java và kết hợp cả hai.

Answer 3

Để thay thế cho Enunciate, bạn cũng có thể xem xét MireDot. Nó phát triển từ một công cụ mà chúng tôi sử dụng trong công ty của riêng mình và nó hoàn toàn miễn phí để sử dụng cho các dự án nguồn mở. Nó thực hiện chính xác những gì bạn mô tả: nó kết hợp các chú thích jaxrs và các chú thích javadoc hiện có để tạo ra một api còn lại. Nó hoạt động như một plugin maven mà bạn chỉ cần thêm vào dự án của bạn. Chú thích Jaxb chưa được hỗ trợ tại thời điểm viết, nhưng công cụ đang được phát triển tích cực và chúng tôi chọn các tính năng để triển khai dựa trên các đề xuất/yêu cầu/phản hồi.