ASP.NET and Web Services Part 2 - Automatically Generated Documentation

(Page 4 of 8 )

The documentation automatically generated for the IFCEBrokerageFirm is shown in Listing 8:

Listing 8 Sample documentation for IFCEBrokerageFirm


SecuritiesExchange
This 
demonstrates how to use the Description attribute
The following operations 
are supported.
For a formal definition, please review the Service 
Description.
StockQuote
This web service is using http://tempuri.org/ as 
its default namespace.
Recommendation: Change the default namespace
before 
the XML Web service is made public.



Examining Namespaces

Each XML web service needs a unique namespace in order for client applications to distinguish it from other services on the Web. The http://tempuri.org/ namespace is available for XML web services that are under development, but published XML web services should use a more permanent namespace.

Your XML web service should be identified by a namespace that you control. For example, you can use your company’s Internet domain name as part of the namespace. Although many XML web service namespaces look like URLs, they need not point to actual resources on the Web. (XML web service namespaces are URIs.)

For XML web services created using ASP.NET, the default namespace can be changed using theWebService attribute’s Namespace property. TheWebService attribute is an attribute applied to the class that contains the XML web service methods. Listing 9 shows an example that sets the namespace to http://microsoft.com/webservices/.

Listing 9 HTML-based documentation


C#
[WebService(Namespace="http://microsoft.com/webservices/")]
public 
class MyWebService {
// implementation
}
Visual 
Basic.NET
<WebService(Namespace:="http://microsoft.com/
webservices/")> 
Public Class MyWebService
' implementation
End Class
For more details 
on XML namespaces,
see the W3C recommendation on Namespaces in XML.
For 
more details on WSDL, see the WSDL Specification.
For more details on URIs, 
see RFC 2396.



This web page shows the method exposed by the web service StockQuote. It also provides the following recommendation:


Recommendation: Change the default namespace
before the XML web 
service is made public.



And it lists some examples for changing the namespace.

Remember: This is part one of chapter 7 .NET & J2EE Interoperability, by Dwight Peltzer (McGraw-Hill/Osborne, ISBN 0-07-223054-1, 2004). If you like what you see, feel free to click on the following link to get your own copy! Buy this book now.

Next: The Web Service WSDL file >>
 

More ASP.NET Articles
More By McGraw-Hill/Osborne

Comments On: ASP.NET and Web Services Part 2

>>> Be the FIRST to comment on this article!