Web Service Documentation

Most developers deplore the idea of writing system documentation. The reason is pretty clear—documenting systems usually involves tedious and uninteresting work. In the Web Services paradigm, many developers think that a simple Web Service Description Language (WSDL) document and its associated XML schema are sufficient documentation for a service. Unfortunately, this just isn't the case.

So what do we mean when we say “documentation”? Generally, it's the information that describes a system's purpose, operation, structure, and data. More specifically, it's the definition of the syntax and semantics of a Web Service, including detailed descriptions of the public operations and their supporting parameters.

Rather than ...

Get Applied SOAP: Implementing .NET XML Web Services now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.