CODEWITHSUNDEEP
restdocumentation-generationservicestack
Froyke
Froyke

Reputation: 1145

Is it possible to auto generate nice documentation for REST API created by ServiceStack?

There are existing tools for auto generating API documentation - most of the weren't designed for REST services.

For all of you who have created REST services using ServiceStack - how did you write the docs ? Manual / semi-auto / fully auto-gen ? I'm even considering auto gen a customized WADL and connecting it to something like apigee Console To Go

(oh and RESTafaries- please spare the 'REST api should be auto discoverable and self-explained' mantra...I really want nice looking docs for my users).

Upvotes: 4

Views: 1517

Answers (1)

Martin Tapp
Martin Tapp

Reputation: 3386

Documenting an API through XHTML might provide better results than formatting DTO's. Look at http://www.amundsen.com/blog/archives/1043 and this inspiring video.

Upvotes: 1

Related Questions