记录ServiceStack Web服务

时间:2011-08-24 08:53:59

标签: web-services rest documentation servicestack

记录ServiceStack基础Web服务的选项有哪些,我不是在谈论单行字符串。

我希望能够详细记录(可能很长),返回类型,可能的HTTP响应,添加详细示例等。

ServiceStack中是否有对此的支持(我找不到它)? 如果没有,有人以其他方式解决了这个问题。

2 个答案:

答案 0 :(得分:4)

您可以通过使用[Api]和[ApiMember]属性归因您的请求DTO,为每个Web服务提供元数据描述。 此信息将显示在动态元数据页面上。

另一种选择是简单地创建自己的动态html页面,ServiceStack允许您通过简单地返回一个字符串(包含您的html标记)来完成。如果您使用此路线,则可以使用全局 EndpointHost.ServiceOperations 属性访问服务类型元数据。

此外,如果使用C#动态生成html不是您的偏好,您还可以使用内置的Razor Markdown format生成html,这使得生成html非常愉快:)

答案 1 :(得分:1)

我意识到这个问题已有几年了,但现在Swagger支持ServiceStack API的@ https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API