TechWriter for Web Services is a documentation generator for web services
that leverages the information locked inside your RESTful web service
to automatically produce Web Service API documentation. TechWriter supports any type of HTTP-based REST service by analyzing and
deriving the structure of the methods from sample request and response URLs that you provide.
With TechWriter® for Web Services you can:
- Save time and money. Instead of spending
hours writing and formatting web service API documentation from scratch, you can finish
the job in seconds with our documentation generator. Creating your first API reference
is only a few mouse clicks away.
- Keep Synchronized. Nobody likes outdated
system documentation. By including TechWriter in your development process
your documentation can be regenerated as your RESTful service changes.
- Easily target different audiences. Give
your readers documentation they can understand by editing and expanding on the descriptions
of your REST methods, arguments and types.
- Choose your output format. Create both
printed and online documentation at the same time. TechWriter can generate your
documentation in PDF, Compiled Help (CHM), Word/RTF, HTML, XPS and XML formats.
- Document multiple Web Services. TechWriter
also supports documenting WSDL-based web services.
And best of all, you can mix and match them
to produce a single document that describes multiple web services.