Jede Art und Weise zu erzeugen WSDL-Dokumentation aus Javadoc mit JAX-WS?

Question

Ich bin die Hoffnung, dass eine Verlängerung von einer Art zur Verfügung steht, das dies tut (obwohl ich glaube, dass meine Hoffnung dummen optimistisch ist).

   /**
     * <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;

Danke, LEs2

Answer 1

Sie sehen können unter enunciate . Es ist möglich, verwenden es ist Maven Plugin statische HTML-Dateien von Javadoc Kommentare zu erzeugen. Dies funktioniert für SOAP (d JAX-WS) und REST (d JAX-RS) Endpunkte.

Interessante lautet:

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

Herstellungsbeispiele:

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

Answer 2

Du bist nicht der einzige, nach einer Möglichkeit, WSDL-Dokumentation zu generieren (siehe Generieren von WSDL-Dokumentation aus Javadoc < Gewinde / a>), aber AFAIK gibt es keine Standard JAX-WS Art und Weise, dies zu tun.

Nun hat vielleicht einen Blick auf JBoss proprietärer Anmerkung @Documentation erwähnte in JBWS-1850 , die in Abschnitt beschrieben erzeugt jaxws:binding Artefakte 2.9 Javadoc- Anpassbarkeit , wenn auch Java-> WSDL-Ansatz. Es ist nicht genau das, was Sie gefragt, aber es könnte Ihnen ein paar Ideen.

Auf jeden Fall denke ich, dass dies erfordern würde Ihre eigene WSDLGeneratorExtension Bereitstellung wsgen zu erweitern und zu erzeugen, um die gewünschte WSDL.

Answer 3

In einem Projekt veröffentlichten wir eine Menge WSDLs. Für jeden Web-Service haben wir eine WS-Methode „getDocumentationURL ()“ ausgesetzt. Diese Methode liefert einen Link auf die JavaDoc vom SEI erzeugt zurück. Die JavaDoc war Platz auf einem Intranet-Server zugänglich.