views:

53

answers:

1

Hi,

I'm writing an XML-RPC service that will be consumed by third parties and was wondering what the best way of documenting it would be.

As far as I can see, XML-RPC doesn't have any equivalent to SOAP's WSDL to provide a description of the service, so presumably it's something I will have to document by hand?

So far I've come accross examples such as that found here and here where documentation basically consists of an example call with place holders for data.

Is there any better method than this that I'm missing? Thanks.

+1  A: 

Check out XML-RPC Introspection. It is about the closest thing to a standard that you are going to find. XML-RPC does lend itself to simple documents of input/output descriptions. If you want something that can be processed programatically, then implement or enable introspection.

D.Shawley