现有工具可用于自动生成API文档，但它们大多数并不是为REST服务而设计的。
对于那些使用ServiceStack创建REST服务的人，你们是如何编写文档的？ 手动/半自动/完全自动生成？ 我甚至考虑自动生成定制化的WADL，并将其连接到类似apigee Console To Go之类的东西上。
(哦，对于REST信徒，请不要再说“REST API应该是自动可发现和自我解释的”了...我真的希望我的用户能看到漂亮的文档)。
ServiceStack创建的REST API是否可以自动生成漂亮的文档？
4
- Froyke
2
嗨Froyke。请参考我的评论https://dev59.com/aWjWa4cB1Zd3GeqPo0BH#22939360，了解记录ServiceStack Web服务的推荐方法。 - Christo
谢谢，但那不太美观，也不太用户友好。最终，我（手动）创建了一个WADL文件，使用XSLT转换成漂亮的HTML。在这里可以看到它的效果：http://developer.dome9.com/reference.html 我也喜欢Apigee的控制台，所以同样的WADL文件可以供他们的控制台使用：https://apigee.com/froyke/embed/console/dome9 - Froyke
1个回答
1
通过XHTML记录API可能比格式化DTO提供更好的结果。请查看http://www.amundsen.com/blog/archives/1043和这个鼓舞人心的视频。
- Martin Tapp
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接