Enforcing trailing slash required by API

[AKrasheninnikov]

Hi!

I'm a new user of your library and it looks very convenient and promising in most cases. However, I am consuming an API that has resources containing dashes and requiring trailing slashes in the endpoint URLs in some cases. I haven't deeply debugged RestClient yet but it seems that the slash I provide in Resource("endpoint/") is omitted. How can I customize RestClient to use URLs I provide verbatim without any trimming?

Thank you in advance.

[DalSoft]

Sure I've had to work with an API like that before. You can use a Delegating Handler to add the trailing slash:

var config = new Config()
                .UseHandler((request, token, next) =>
                {
                    request.RequestUri = new Uri(request.RequestUri.ToString() + "/");
                    return next(request, token);
                });
            
dynamic client = new RestClient("https://jsonplaceholder.typicode.com", config);

// With the Delegating Handler above this would call https://jsonplaceholder.typicode.com/my-users/
var user = await client
                .Resource("my-users")
                .Get();

Let me know if this works for you.

D

[AKrasheninnikov]

Hello, D!
Thanks a lot for the sample! It works on a particular request, but I'll have to figure out a way to keep the Uri verbatim rather than forcefully append the trailing slash because some endpoints require the slash and some prohibit it. Anyway, your help was (and will be) greatly appreciated!

[AKrasheninnikov]

I need to intercept the RequestUri change before (or exactly where) it happens. Can you tell me where to look?

[AKrasheninnikov]

Found this in HttpVerbCommand.cs. Looks like I need a custom build without those lines for now:)

        private static Uri ParseUri(string httpMethod, string currentUri, object[] args)
        {
            if (args.Length > 0 && httpMethod.IsImmutableVerb())
            {
                ResourceCommand.ValidateResourceArgs(args);
                currentUri += "/" + args[0];
            }

            **if (currentUri.EndsWith("/"))
                currentUri = currentUri.TrimEnd("/".ToCharArray());**

            if (!Uri.TryCreate(currentUri, UriKind.Absolute, out var uri))
                throw new ArgumentException($"{currentUri} is not a valid Absolute Uri");

            return uri;
        }

[DalSoft]

Yes that's the place to do it, I tested it and it works as expected. Unfortunately it will need to be a custom build for now. I have a story in the backlog for allowing chain extension with your own dynamic commands.

Then it would be as simple as writing your command and doing restClient.MyCommandDoesntTrimUri("my-resource/")

Sorry it wasn't as easy as it should of been to do this.

[DalSoft]

I also have thought of a easy change I can add that might workaround this issue, I try and get something out today.

[AKrasheninnikov]

Perhaps an optional parameter would fit a call like .Resource(string, SlashTrimmingOption.NoTrimming)?

enum SlashTrimmingOption {

• NoTrimming
• TrimStart
• TrimEnd
• TrimAll

}

At least from the .Resource(...) usage perspective it looks an appropriate place to put. If we used chaining to build the Uri, then we need some other solution Like an explicit .Slash() call.

[DalSoft]

What I was thinking is if you passed a slash in Resource() not to trim it, unlikely to be a breaking change and keeps it clean. I'll definitely add this just half though 3.3.3 ate the moment. I leave this open and close when I release 3.3.3 with this fix.