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

大憨熊 提交于 2019-12-06 06:13:20

问题


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).


回答1:


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.



来源:https://stackoverflow.com/questions/12089153/is-it-possible-to-auto-generate-nice-documentation-for-rest-api-created-by-servi

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!