Win a copy of The Java Performance Companion this week in the Performance forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

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

 
Partha Krishnan
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 263
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
WSDL is to serve this purpose only. Isn't it?
 
Partha Krishnan
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Rancher
Posts: 42968
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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?
 
Partha Krishnan
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Rancher
Posts: 42968
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic