Daemonite: Ideas for Documenting Webservices Archive

Daemonite: Ideas for Documenting Webservices Archive


Friday, April 18, 2003
Ideas for Documenting Webservices

I've had a webservice up for fullasagoog for some time (fullasagoog: Public Webservice Available) but I never got round to documenting it. I've been mulling over this plan of building a nice formatter for the CFC metadata of the webservice for ages.

If you grab the output from getMetadata() there's all the information you need and more. But like many of us I head off down the path of least resistance making happy *beeping* noises -- hence my relief when I stumbled across Nathan Dintenfass' cfcremotedocumenter.

cfcremotedocumenter is basically a set of methods you include into your webservice CFC (or any CFC for that matter) and it provides nicely formatted metadata, like so: Fullasagoog Webservice.

I had to make the odd modification to get the code to work inside my page layout -- but for the most part it's straightforward. It would be nice to see more effort put into CF's built-in Component Browser -- I for one would like it as a set of CFC's you can deploy for any application, with options to restrict documentation to specific packages and access types (like remote).

(And was it really necessary to encrypt the source for component browser?? Crazy. Looks like I might have to build one of my own... some time.)

Posted by modius at 03:52 AM | Permalink
Trackback: http://blog.daemon.com.au/cgi-bin/dmblog/mt-tb.cgi/106

Comments

The webService still returns an error as reported previously.

Also, why does
http://www.fullasagoog.com
look different to
http://foolasagoog.com

Posted by: Hilary Bridel on April 18, 2003 03:49 PM