RE: documentation generated from .wsdl

by Jonathan Marsh-2 :: Rate this Message:

Some parts of this message have been removed. Learn more about Nabble's security policy.

Tomi,

I like the view you’ve created, and would encourage a WSDL 2.0 equivalent as well! In conjunction with conventions for how structured <wsdl:documentation> elements could be added to the display it would make an invaluable tool. I generate something similar but much more limited from the WSDL [0], in this case abstracting out the differences between WSDL 1.1 and WSDL 2.0 representations of the service.

Incidentally I’ve also done something similar to your source code appendix but a little more elaborate – an xslt stylesheet that pretty-prints the source code of the WSDL and then makes QName and URI references clickable for easy navigation, annotates items with their back-links, and generates indexes of the constructs. Stylesheets are available for WSDL 1.1, WSDL 2.0, and XML Schema 1.0. You can get them at [1], or you can see an annotated WSDL 2.0 example at [2], or the annotated schema for schemas at [3]. They’re under the Apache Open Source License.

[0] http://mashups.wso2.org/services/storexml?doc

[1] http://wso2.org/repos/wso2/trunk/commons/annotated-stylesheets/readme.htm

[2] http://mashups.wso2.org/services/LatestEarthquakes?wsdl2&annotation=true

[3] http://wso2.org/repos/wso2/trunk/commons/annotated-stylesheets/XMLSchema.xsd

Jonathan Marsh - http://www.wso2.com - http://auburnmarshes.spaces.live.com

From: www-ws-desc-request@... [mailto:www-ws-desc-request@...] On Behalf Of Arthur Ryman
Sent: Friday, October 05, 2007 1:08 PM
To: tomi vanek
Cc: www-ws-desc@...; www-ws-desc-request@...
Subject: Re: documentation generated from .wsdl

Tomi,

I see this is for WSDL 1.1. Have you thought of supporting WSDL 2.0? If you want to contribute your code, maybe the Apache Woden project [1] could provide a home.

Another thought is to leverage the WSDL 2.0 Component Model Interchange format [2] - an XML format that combines the content of multiple WSDL 2.0 and XSD files (via import and include) into a single file. This format is used in the Test Suit and is implemented by Woden.

[1] http://incubator.apache.org/woden/
[2] http://dev.w3.org/cvsweb/2002/ws/desc/test-suite/interchange/

Arthur Ryman, PhD, AoT, DE
Process and Portfolio Management, Rational Division

phone: +1-905-413-3077, TL 969-3077
assistant: +1-905-413-3831 (T/L: 318-8867)
fax: +1-905-413-4920, TL 969-4920
mobile: +1-416-939-5063, text: 4169395063@...

tomi vanek <tomi.vanek@...>
Sent by: www-ws-desc-request@...

10/04/2007 10:22 AM

To	www-ws-desc@...
cc
Subject	Re: documentation generated from .wsdl

Michael Potter-3 wrote:
I have a need to document our webservices in a format usable by non-technical users.
Maybe you could find useful my tool for WSDL documentation generation: the wsdl-viewer.xsl (http://tomi.vanek.sk/index.php?page=wsdl-viewer). This is just an XSLT 1.0 transformation that can run in any browser. The transformation converts WSDL into easier understandable HTML format. You can create the documentation either with batch processing (i.e. by ANT script), or simply by adding a processing instruction into WSDL, so by opening the WSDL in a browser the XML will be instantly converted into HTML.

View this message in context: Re: documentation generated from .wsdl
Sent from the w3.org - www-ws-desc mailing list archive at Nabble.com.

« Return to Thread: documentation generated from .wsdl