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

Question

My WebApi has methods that look like the method below. Is there a way to provide input examples using 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...
}

score 0 · Answer 1 · answered Jul 27 '16 at 12:52

0

The best way SwashBuckle would handle this is to have one method per object type, which would then help you to have one method entry in your Swagger descriptor (easier for consumers).

Still, having a REST API endpoint that accepts "anything" is not really much REST oriented; how would people using your Swagger endpoint would guess what they should send?

answered Jul 27 '16 at 12:52

Benjamin Soulier

2,223
1
18
30

I know it's not really very RESTy. But to answer your question, this is why I want to manually populate the "Example" data part of the Swashbuckler doc. – Webjedi Jul 28 '16 at 14:41
Your only solution then is to modify the output documentation from Swashbuckle, creating a custom `IDocumentFilter` to duplicate generated schema entries, and to use it with `c.DocumentFilter` – Benjamin Soulier Jul 28 '16 at 14:49

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

1 Answers1