繁体   English   中英

当您的API方法参数包含动态对象时,如何在swashbuckler / swagger中提供JSON示例?

[英]How do you provide JSON examples in swashbuckler/swagger when your API method parameters have dynamic objects?

我的WebApi具有类似于以下方法的方法。 有没有办法使用Swashbuckler提供输入示例?

public UserModel Login([FromBody] JObject data)
{
            dynamic json = data;
            string sdkversion = (string) json.sdkversion;
            string loginid = json.loginid;
            string password = json.password;
            string ipaddress;
            string jsonipaddress = (string)json.ipaddress;
            string hostname = HttpContext.Current.Request.UserHostName;
            string useragent;

            useragent = (string)json.useragent;

        Do stuff...
}

SwashBuckle处理此问题的最佳方法是为每个对象类型拥有一个方法,这将帮助您在Swagger描述符中拥有一个方法条目(对消费者更容易)。

尽管如此,拥有一个可以接受“任何内容”的REST API端点并不是真正面向REST的东西。 使用Swagger端点的人们将如何猜测他们应该发送什么?

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM