C#•3y ago

✅ Refit / RestLess API SDK Structure

Hey!

How do I structure an SDK for my API?

Let's say I have 2 resources: Users and Groups.

I could use Refit or RestLess to create an interface which wraps the CRUD operations on both resources.

However if I add more resources (which I do have) to the interface it gets messy.

Is there a way to structure my API SDK like this?

public interface IMyApi
{
    public IMyUsersApi Users { get; }
    public IMyGroupsApi Groups { get; }
}

public interface IMyApi
{
    public IMyUsersApi Users { get; }
    public IMyGroupsApi Groups { get; }
}

public interface IMyApi
{
    public IMyUsersApi Users { get; }
    public IMyGroupsApi Groups { get; }
}

public interface IMyApi
{
    public IMyUsersApi Users { get; }
    public IMyGroupsApi Groups { get; }
}

Where

IMyUsersApi

IMyUsersApi

IMyUsersApi

IMyUsersApi and

IMyGroupsApi

IMyGroupsApi

IMyGroupsApi

IMyGroupsApi would contain all CRUD operations for their resource.

DustyOP•4/11/23, 9:54 AM

Anyone?

canton7•4/11/23, 9:57 AM

What's your problem? Can't you do just that -- have one class which contains a Refit interface for users, and one for groups?

Ccanton7 What's your problem? Can't you do just that -- have one class which contains a R...

DustyOP•4/11/23, 10:00 AM

Can you? I haven't seen documention about it.

I've seen others having one big interface having all methods for every endpoint inside it

canton7•4/11/23, 10:01 AM

You can just create a class?

canton7•4/11/23, 10:01 AM

No need to get Refit involved there

canton7•4/11/23, 10:02 AM

public class MyApi : IMyApi
{
    public IMyUsersApi Users { get; } = RestClient.For<IMyUsersApi>();
    ...
}

public class MyApi : IMyApi
{
    public IMyUsersApi Users { get; } = RestClient.For<IMyUsersApi>();
    ...
}

canton7•4/11/23, 10:02 AM

(or whatever the refit syntax is)

DustyOP•4/11/23, 10:04 AM

Oh I see

DustyOP•4/11/23, 10:04 AM

Wow that's actually really simple

DustyOP•4/11/23, 10:04 AM

Didn't think of that somehow

DustyOP•4/11/23, 10:05 AM

You really saved me from a lot of headaches

✅ Refit / RestLess API SDK Structure

Similar Threads

Similar Threads

Similar Threads