记录ServiceStack Web服务

Question

如何记录ServiceStack基于Web服务的选项，我不是指一个一行字符串。

我希望能够详细记录（可以很长）返回类型，可能的HTTP响应，添加详细的示例等。

ServiceStack是否支持此功能（我找不到）？ 如果没有，有人用其他方法解决了这个问题吗？

- tymtam

Answer 1

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

另一种选择是创建自己的动态 HTML 页面，ServiceStack 允许您通过简单地返回一个包含您的 HTML 标记的字符串来实现此目的。如果您采用这种方法，您可以使用全局 EndpointHost.ServiceOperations 属性访问服务类型元数据。

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

- mythz

---

[ApiMember] 属性是如何使用的？我发现如果您转到根 API 并使用 DTO 导航到端点，则会显示 [Api] 信息... 但我找不到 [ApiMember] 的使用位置。 - brian-d

Answer 2

我知道这个问题已经有几年了，但现在ServiceStack API支持Swagger。请查看https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API获取更多信息。

- JesseP