*
The moose likes Web Services and the fly likes AXIS 2 : Developing a help page for a Web service created Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of The Java EE 7 Tutorial Volume 1 or Volume 2 this week in the Java EE forum
or jQuery UI in Action in the JavaScript forum!
JavaRanch » Java Forums » Java » Web Services
Bookmark "AXIS 2 : Developing a help page for a Web service created" Watch "AXIS 2 : Developing a help page for a Web service created" New topic
Author

AXIS 2 : Developing a help page for a Web service created

Partha Krishnan
Greenhorn

Joined: Apr 06, 2010
Posts: 3
Hi,

I would like to know how to create a documentation page for a webservice I created using axis 2.

For example, I would like to give the webservice user a guide about the details of my service, how to use it, what parameters to be passed etc.

Can any one please help me in this regards ?. Any thoughts ?

Thanks,
Partha.
shivendra tripathi
Ranch Hand

Joined: Aug 26, 2008
Posts: 263
WSDL is to serve this purpose only. Isn't it?


SCJP 1.5(97%) My Blog
Partha Krishnan
Greenhorn

Joined: Apr 06, 2010
Posts: 3
shivendra tripathi wrote:WSDL is to serve this purpose only. Isn't it?



well.. i am giving a jar file to the user which will make the webservice call to my service.. I want to put out a documentation for how to use the method in the jar file(the parameters, the meaning of the parameters).. where should they put this jar file and other good stuff.
Ulf Dittmer
Marshal

Joined: Mar 22, 2005
Posts: 41599
    
  55
Are you asking for help about how to write a document? If it's a service you (or your company) developed, then you'd be best placed to know what should go into the document so that clients can use the service without further hand-holding, no?


Ping & DNS - my free Android networking tools app
Partha Krishnan
Greenhorn

Joined: Apr 06, 2010
Posts: 3
Ulf Dittmer wrote:Are you asking for help about how to write a document? If it's a service you (or your company) developed, then you'd be best placed to know what should go into the document so that clients can use the service without further hand-holding, no?


OK. Let me put it this way.. I want to provide a url like we provide a url for the WSDL. In that URL i would like to show the documentation. Ofcourse, i can put it in a common place to accessed by every other team in the company but i want to provide it as a part of the webservice.

the way to download wsdl will be like
http://hostname:portnumber/application_name/services/service_name

the way i would like to have my documentation is
http://hostname:portnumber/application_name/services/service_name/help

this might not be possible but i am exploring the possibility.
Ulf Dittmer
Marshal

Joined: Mar 22, 2005
Posts: 41599
    
  55
WSDL (or SOAP) has no provisions for generating (or displaying) HTML pages. You could host the page at http://hostname:portnumber/application_name/doc/service_name/ or some such URL.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: AXIS 2 : Developing a help page for a Web service created