我正在使用ServiceStack,我想帮助生成元数据的“自动文档”。
我最近找到了ApiAttribute
和ApiMemberAttribute
(mentioned here和here)。但是,我无法获取http://me/api/metadata?op=ReadFormType
页面以发布装饰成员的任何信息。
他是我的DTO(它只是一个存根到目前为止)的精简版,它使用了一个测试属性:
[Api("Read FormType")]
[Route("/formTypes/{FormType}", "GET")]
public class ReadFormType
{
[ApiMember(Name = "X", Description = "X Description",
ParameterType = "path", DataType = "string", IsRequired = true)]
public string X { get; set; }
}
ApiAttribute
文本 正确显示在元数据响应的顶部,并且 成员在下面的请求DTO部分中正确列出。
为了在ApiMemberAttribute
中显示额外信息,我需要做什么? (或者我误解了这个属性是如何工作的?)
ServiceStack的版本是3.9.35。
答案 0 :(得分:2)
Api
和ApiMember
属性目前在ServiceStack's Swagger support中使用。
但是我们还会在ServiceStack的下一个版本中将它们包含在ServiceStack的自动生成的元数据页面中。