Other than pasting a WDSL in the tech spec, what are the recommended ways to document a WCF web-service before you begin coding?
+2
A:
Document the contract interface as you would document any other interface. Describe the operations, pre-conditions, post-conditions, reasons for throwing a fault, etc.
Dave Dunkin
2008-10-09 19:56:33
+1
A:
Also, in case you're using MessageContracts document why you are using them... trust me, you'll wonder why you did it :)
sebastian
2008-10-09 19:58:43
+1
A:
- Describe service endpoints and available protocols/binding. e.g. Https, RESTful?
- Security features, authentication, authorization and encryption.
- Explain the use cases of parameters in operation contract.
- Hosting, IIS, WindowsService or Console application.
- Instancing of the service.
codemeit
2008-10-09 20:08:00
+2
A:
Microsoft documents some WCF services in MSDN. I think that you can get some ideas from the following links:
Panos
2008-10-09 20:32:15
+4
A:
We recently published a WCF based SOAP interface for third parties to integrate against. For each method we provided the following:
- Method name
- Request example (wire format dump)
- Request parameters explanation
- Response example (wire format dump)
- Request parameters explanation
- Caveats (gotchas)
- History
We also provide the WSDL. You may want to use Microsoft's Disco.exe for doing this. See also a related question about obtaining the WSDL.
Thomas Bratt
2008-10-11 20:43:37