Creating RESTful API documentation from a WCF service

Question

I recently started a project to create a RESTful API in WCF, and I will need to provide documentation along with the API itself. I was hoping to use XML code comments in my docs for this documentation.

But what I want to infer is simply the contracts that are exposed by the service: endpoints and structures of JSON / XML objects. Since I'm trying to create external documentation, I'm interested in some kind of internal part of my library or how it relates to the .Net Framework (or even that it is .Net, for that matter).

What are my options for tools to create these documents? I heard Sandcastle or Doxygen are good tools for generating documents from XML code comments, but can I filter out classes and methods that I don't want to disclose?

Answer 1

Of course, you can filter out unwanted APIM members using Sandcastle. This blogger describes how to do this. If you're new to Sandcastle, you can try Sandcastle Help File Builder , which is basically Sandcastle Frontend.

Answer 2

I understand that this question was asked by pre-.NET 4.0, but with .NET 4.0 you can create a help page as described in the WCF HTTP Web Help page .

WCF 4.0 Example

[System.ComponentModel.Description("Triggers Method Name Behavior.")] public void MethodName() {} 

Answer 3

You can configure doxygen to generate a document from files. Why don't you see the doxygen docs?