是否可以为 ServiceStack 创建的 REST API 自动生成好的文档? [英] Is it possible to auto generate nice documentation for REST API created by ServiceStack?

问题描述

现有工具可用于自动生成 API 文档 - 其中大部分不是为 REST 服务设计的.

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

对于所有使用 ServiceStack 创建 REST 服务的人 - 你们是如何编写文档的?手动/半自动/全自动发电机?我什至在考虑自动生成一个定制的 WADL 并将其连接到类似 apigee Console To Go

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

(哦，还有 RESTafaries——请不要说REST api 应该是自动发现和自我解释的"口号……我真的想要为我的用户提供漂亮的文档).

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

推荐答案

通过 XHTML 记录 API 可能比格式化 DTO 提供更好的结果.查看 http://www.amundsen.com/blog/archives/1043 和这个鼓舞人心的视频.

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.

这篇关于是否可以为 ServiceStack 创建的 REST API 自动生成好的文档?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！