5

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

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

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

4

2 回答 2

4

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

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

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

于 2011-08-26T02:07:21.287 回答
1

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

于 2013-08-26T18:49:40.217 回答