Bất kỳ cách nào để tạo tài liệu WSDL từ Javadoc với JAX-WS?

Question

Tôi hy vọng rằng một phần mở rộng của một số loại có sẵn mà thực hiện điều này (mặc dù tôi cho rằng hy vọng của tôi là lạc quan ngu ngốc).

/** 
    * <p> 
    * Gets the {@link ResultObject} given the identifier. The following 
    * fields are not available for some users and will contain a null value: 
    * </p> 
    * 
    * <ul> 
    * <li>{@code resultObject.comment}</li> 
    * <li>{@code resultObject.anotherObject.actionById}</li> 
    * <li>{@code resultObject.anotherObject.actionByName}</li> 
    * </ul> 
    * 
    * <p> 
    * The {@code daysInPurgatory} value will be {@code -1} when not 
    * applicable 
    * </p> 
    * 
    * @param requestUser 
    *   the user initiating the request 
    * @param identifier 
    *   the id of the ResultObject 
    * @return the {@link ResultObject} or {@code null} if none exists 
    * @throws SomeException 
    *    if the {@code identifier} is {@code null} 
    */ 
    @WebMethod 
    @WebResult(name = "resultObject") 
    public ResultObject getResultObjectById(
    @WebParam(name = "RequestUser", header = true, partName = "RequestUser") final String requestUser, 
    @WebParam(name = "identifier") final Long identifier) 
    throws SomeException; 

Cảm ơn, LES2

Answer 1

Bạn có thể xem Enunciate. Có thể sử dụng it's Maven plugin để tạo tệp HTML tĩnh từ nhận xét của Javadoc. Điều này làm việc cho các điểm cuối SOAP (tức là JAX-WS) và REST (tức là JAX-RS).

Thú đọc:

• https://github.com/stoicflame/enunciate/wiki/Documentation-Only
• http://raibledesigns.com/rd/entry/my_experience_with_java_rest

Sản xuất Ví dụ:

• http://www.realtybaron.com/api/
• http://www.agentrank.com/api/
• http://api.setlist.fm/docs/index.html

Answer 2

Bạn không phải là người duy nhất tìm kiếm một cách để tạo ra tài liệu WSDL (xem thread Generating WSDL documentation from Javadoc) nhưng, AFAIK, không có chuẩn JAX-WS cách để làm điều này.

Bây giờ, có lẽ có một cái nhìn tại JBoss chú thích độc quyền @Documentation nêu tại JBWS-1850 mà tạo ra jaxws:binding hiện vật được mô tả trong phần 2.9 Javadoc Customization khi sử dụng Java-> cách tiếp cận WSDL là tốt. Nó không chính xác những gì bạn yêu cầu nhưng nó có thể cung cấp cho bạn một số ý tưởng.

Trong mọi trường hợp, tôi đoán rằng điều này sẽ yêu cầu cung cấp WSDLGeneratorExtension riêng của bạn để mở rộng wsgen và tạo WSDL mong muốn.

Answer 3

Trong một dự án, chúng tôi đã xuất bản rất nhiều WSDLs. Đối với mọi Dịch vụ Web, chúng tôi đã tiếp xúc với phương thức WS "getDocumentationURL()". Phương thức này cung cấp một liên kết tới JavaDoc được tạo ra từ SEI. JavaDoc được đặt trên một máy chủ mạng nội bộ có thể truy cập.