• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Ron McLeod
  • Rob Spoor
  • Tim Cooke
  • Junilu Lacar
Sheriffs:
  • Henry Wong
  • Liutauras Vilda
  • Jeanne Boyarsky
Saloon Keepers:
  • Jesse Silverman
  • Tim Holloway
  • Stephan van Hulst
  • Tim Moores
  • Carey Brown
Bartenders:
  • Al Hobbs
  • Mikalai Zaikin
  • Piet Souris

how to generate documentation for a webservice

 
Greenhorn
Posts: 6
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hello everybody,

I suppose it is a trivial question, but can anyone suggest the best way to generate documentation for the webservice interface (parameters, exception etc)?

Thanks
 
Ranch Hand
Posts: 98
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Marzio.

If you want to create documentation so the users of your Web Services can create client code to use it, you only need to create a WSDL file. If you don't want to generate a WSDL file from scratch, some SOAP engines provide a tool called Java2WSDL, which will create a WSDL file from a Java class.

If you want to provide verbal documentation about your WS then I still think it would go into the WSDL, but I haven't done that. I'm also not aware of a Javadoc-like tool for WSDL files, but there may be one. Hopefully somebody else has done it and will post the experience.

Regards.
 
marzio logiudice
Greenhorn
Posts: 6
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hello Paulo,

thanks for the help. Yes, I need to provide some human readable documentation for the usage of the interface, together with the wsdl file.
I thought there was some standard way to do that (like javadoc a/o annotations)

Actually, I have to deploy a webservice to be used by a customer to monitor the status of the implementation of new features, and I'd like to authomate the process of creating human readable documentation any time a new feature is released or updated.
 
It is an experimental device that will make my mind that most powerful force on earth! More powerful than this tiny ad!
Thread Boost feature
https://coderanch.com/t/674455/Thread-Boost-feature
reply
    Bookmark Topic Watch Topic
  • New Topic