2010年3月1日星期一

[fw-webservices] Generating end user documentation for SOAP services.

Hi.

I've got a webservice using Zend_Soap_Server (along with AutoDiscover
and WSDL from the Zend Framework).

I used DocBlocks to describe my code and I can happily produce the
developer level documentation for the classes (55 classes dealing with
authentication, supplying data and versioning).

I would like to be able to produce end-user documentation which is
pretty limited in scope as it only needs to document the calls/methods
that they can make via SOAP and not to show the internal workings
(which is what my developer level documentation is showing). I'd like
to be able to generate the documentation automatically (like
phpdocumentor).

So, can I build documentation from a WSDL file?

The WSDL file contains <documentation> tags. I'd like to be able to
add documentation to the complex types (not sure that is possible via
WSDL).

Ideas, suggestions, links, experience, etc. would be gratefully received.


Regards,

Richard Quadling.

--
-----
Richard Quadling
"Standing on the shoulders of some very clever giants!"
EE : http://www.experts-exchange.com/M_248814.html
EE4Free : http://www.experts-exchange.com/becomeAnExpert.jsp
Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731
ZOPA : http://uk.zopa.com/member/RQuadling

没有评论: