Pass json params in get requests

Question

I have:

public class Query {...}
public interface IClient
{
    [Get("/api/endpoint?data={query}")]
    Task<Result> GetData(Query query);
}

but Refit on the Query instance calls ToString instead of using the serializer. Is there any way to achieve this without using a wrapper class?

Answer 1

If I understand the docs correctly, the only issue is the naming. Since you are using it as a param instead of a part of the path, it would be closer to this:

public class Query {...}
public interface IClient
{
    [Get("/api/endpoint")]
    Task<Result> GetData(Query data);
}

Then call it as you normally would:

GetData(aQueryObject);

or

http://myhost/api/endpoint?data=somestuff

Answer 2

I ended up using a custom serializer which converts to JSON every type except primitive types and those implementing IConvertible:

class DefaultUrlParameterFormatter : IUrlParameterFormatter
{
    public string Format(object value, ParameterInfo parameterInfo)
    {
        if (value == null)
            return null;

        if (parameterInfo.ParameterType.IsPrimitive)
            return value.ToString();

        var convertible = value as IConvertible; //e.g. string, DateTime
        if (convertible != null)
            return convertible.ToString();

        return JsonConvert.SerializeObject(value);
    }
}

var settings = new RefitSettings
{
    UrlParameterFormatter = new DefaultUrlParameterFormatter()
};