WSDL Documentation/Comments

[Richard Plana <Ri...@enabil.com>]

Hi,

We use Axis2 to implement our webservice and we’ve taken to using the bottom-up approach of creating Java POJOs first. I was wondering if there was a way to put comments/documentation in our Java code and have that transcribed into the generated WSDL file (as generated by the app server) so that it can be used to create an API usage document with an application like (TechWriter). We just want our WSDLs to be self-documented.

RE: WSDL Documentation/Comments

[Martin Gainty <mg...@hotmail.com>]

use CDATA which tells the processor dont process this as markup ..here is an example

 

<soapenv:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssec urity-utility-1.0.xsd" wsu:Id="Id-17777129"> 

<s1:EdiCustomsDeclaration xmlns:s1="http://www.examples.com/schemas/custom/edi/v1"> &lt;![CDATA[A'B'C'D]]&gt; </s1:EdiCustomsDeclaration> 

</soapenv:Body></soapenv:Envelope> 


HTH
Martin 
______________________________________________ 
Verzicht und Vertraulichkeitanmerkung/Note de déni et de confidentialité

Diese Nachricht ist vertraulich. Sollten Sie nicht der vorgesehene Empfaenger sein, so bitten wir hoeflich um eine Mitteilung. Jede unbefugte Weiterleitung oder Fertigung einer Kopie ist unzulaessig. Diese Nachricht dient lediglich dem Austausch von Informationen und entfaltet keine rechtliche Bindungswirkung. Aufgrund der leichten Manipulierbarkeit von E-Mails koennen wir keine Haftung fuer den Inhalt uebernehmen.

Ce message est confidentiel et peut être privilégié. Si vous n'êtes pas le destinataire prévu, nous te demandons avec bonté que pour satisfaire informez l'expéditeur. N'importe quelle diffusion non autorisée ou la copie de ceci est interdite. Ce message sert à l'information seulement et n'aura pas n'importe quel effet légalement obligatoire. Étant donné que les email peuvent facilement être sujets à la manipulation, nous ne pouvons accepter aucune responsabilité pour le contenu fourni.

  




From: Richard.Plana@enabil.com
To: java-user@axis.apache.org
Date: Fri, 23 Aug 2013 11:49:09 -0600
Subject: WSDL Documentation/Comments




Hi,
 
We use Axis2 to implement our webservice and we’ve taken to using the bottom-up approach of creating Java POJOs first. I was wondering if there was a way to put comments/documentation in our Java code and have that transcribed into the generated WSDL file (as generated by the app server) so that it can be used to create an API usage document with an application like (TechWriter). We just want our WSDLs to be self-documented.