【发布时间】:2012-08-23 09:57:55
【问题描述】:
有用于自动生成 API 文档的现有工具 - 大多数不是为 REST 服务设计的。
对于所有使用 ServiceStack 创建 REST 服务的人 - 您是如何编写文档的? 手动/半自动/全自动? 我什至在考虑自动生成一个定制的 WADL 并将其连接到类似 apigee Console To Go
(哦,还有 RESTafaries - 请保留“REST api 应该是自动发现和自我解释”的口头禅……我真的希望为我的用户提供好看的文档)。
【问题讨论】:
-
嗨弗罗伊克。请参考我的评论 stackoverflow.com/a/22939360/214747 以获取记录 ServiceStack Web 服务的推荐方式。
-
谢谢,但这在视觉上没有那么吸引人,也不是那么用户友好。一天结束时,我(手动)创建了一个 WADL 文件,该文件使用 XSLT 转换为漂亮的 HTML。在此处查看实际操作:developer.dome9.com/reference.html 我也喜欢 Apigee 的控制台,因此相同的 WADL 文件可以为他们的控制台提供信息:apigee.com/froyke/embed/console/dome9
标签: rest documentation-generation servicestack