web-services - 记录 ServiceStack Web 服务

Question

关闭。这个问题需要更多focused .它目前不接受答案。












想改善这个问题吗？更新问题，使其仅关注一个问题 editing this post .

3年前关闭。




Improve this question




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

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

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

Answer 1

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

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

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