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

时间:2016-07-08 17:51:02

标签: json swagger-ui swashbuckle

我的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...
}

1 个答案:

答案 0 :(得分:0)

SwashBuckle处理此问题的最佳方法是为每个对象类型设置一个方法,这样可以帮助您在Swagger描述符中创建一个方法条目(对消费者来说更容易)。

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