Intro to Refit REST API Client for C#
ฝัง
- เผยแพร่เมื่อ 19 ก.ย. 2024
- Calling an API can be a pain. You have to use the HTTPClient correctly, you need to handle the return types, deserialize the data, and more. Or at least, you used to have to do all of that. Not anymore if you use Refit. Refit is an automatic type-safe REST library for Xamarin and .NET. In this video, we are going to set up an API and then call it from Blazor WebAssembly using Refit. You will be amazed at how easy it is to talk to an API.
Full Training Courses: IAmTimCorey.com
Source Code: leadmagnets.ap...
Refit REST Client: reactiveui.git...
Mailing List: signup.iamtimc...
Much quicker and easier solution than managing the http client on your own. Don't even want to mention unit testing. Great stuff!
Thanks!
Refit is an awesome tool to have in my toolbox.. thank you for the awesome introductory video 😇
I am glad it was helpful.
While Refit reduces the amount of boilerplate code you have to write when integrating with an API to a minimum, and is nice to use for smaller APIs, I think it is more useful to use code generation for the client side, based on OpenAPI/Swagger doc (either from VS or other options like NSwag Studio). That is also very helpful in updating the code when the API is updated, and there is less room for error on the client side.
Ya beat me to it. Using swagger code generators is a must in big projects. I cant imagine doing all that work to get refit to work on a big project. For reference I've seen generated nswag clients that are 18k lines. While that would be smaller in refit (as you only need the interface) it is also a lot of work by hand where you only need to set up nswag once and just regen any time you (or co-workers, or vendors) make changes to the api.
Awesome video, thank you. I have never heard about refit btw
I'm glad I was able to introduce you to something new.
Great unique video,. I scoured the internet to find an example of creating a web api, using another project in your solution to call the api, but most of all there was no database, just creating lists to use in the Api..
Glad it was helpful!
This what I been looking for 🔥🔥 You rock Tim!!!
Great!
Great intro to Refit and thanks for the explanation with @onclick="@(e => AddGuest(item))" @35:30 mark
You are welcome.
Your issue with duplicated id was caused by your count + 1. But if you had used .Max(x => x.Id) + 1 it works :) It's easy to make mistakes in recordings :)
Great videos as usual! :)
True. It was also due to trying to do it "quick and dirty" on the client-side rather than actually use a database like you normally would. That fix would be the solution for that issue, though. Good catch.
I think that we dont need "Where" in
guests.Where(g => g.Id == id).FirstOrDefault();
simpler is
guests.FirstOrDefault(g => g.Id == id);
ReSharper suggest such a change as well, but if I recall correctly there were some videos on the topic and choosing .Where over passing predicate into another LINQ function may bring you performance benefits
you are sooo good in explaiinning things!!!
Thanks!
This is awesome. Reminds me a bit of the integration wizard for Web Services that comes with VS by default. Thanks for sharing!
You are welcome.
I'm currently watching one of your other videos on APIs and then I'll do this one! Thank you so much Tim! I've managed to connect to the server and provide my authentication but I'm not quite to getting useful information out of it yet.
I am glad they have been helpful.
Thank you for this tutorial
Thanks for your faith and ongoing support of Tim
Excellent tool. Thanks you for another great video. Will use this in my projects.
Thank you!
Absolutely interesting and helpful tools. Thanks a lot for sharing !
You are welcome.
Excellent Tutorial
Thank you!
Thank you Tim!
This video tutorial help a lot make services simple
You are welcome.
Thanks for the tutorial. It will be very interesting to see one about progressive web apps
I will add it to the list. Thanks for the suggestion.
Hi Tim! Thanks a lot. I`ve only one question: "How should I design the interface if the rest service sends an IActionResult back to caller instead of the awaited object?" Normally on an api call an IActionResult will be send back like Ok(...) or NotFound. THX. Jürgen
Great course!!!
Thank you, Thank you, Thank you.
You are welcome.
As this amazing package encapsulates the network request, it is a little bit difficult to see the cause of problems when things do not work. Is it possible to see the content of the body in a Post request? Is there some tooling in Visual Studio that has this? I had problems because the format of a DateTime in the model class was not right for my WebAPI, which I fixed kind of just by guessing that that might be what was wrong, but it would be nice to be able to get more information for troubleshooting.
Hi Tim, How can I set The Content-Type to application/json in Refit
Excellent tuts. Keep it up 👍
Thanks, will do!
I prefer this way to generating the full api, why would I want 100 classes if i only need a few endpoints?
As always :-) great Video. Great work *ThumbsUp
Thanks!
You are amazing!
I appreciate the kind words.
Just like 'Retrofit' in java & android. Seems nice!
Thanks for spending your time watching.
I LOVE this guy. Dear Tim Corey! What's the story?
Thanks! As for the story, not sure what story you are wanting to hear.
Hey Corey, my dad owns a tent rental buisness (think of large circus tents) and I was thinking I want to build an utility app for android and iOS that allows us to schedule events, keep inventory, and track employee hours.
The challenge is I only know c# and have almost zero knowledge and experience outside of simple Unity and Console apps. No web experience or anything beyond standalone desktop apps that don't do more than mess with local files or run a simple game.
Where do i even begin? I imagine I'll need to rent a server, but i wouldn't know how to use it.
@@kujingo Do you need any interns ?
@@kujingo it does, but I don't have any money - and I don't think my dad is interested in investing into something like that unless it's to support me.
@@kujingo ya let's chat.
if it helps you, and if you already know some c#, MAUI is a very good option for mobile and also Blazor to create web applications
What if u have multiple interfaces must u add a refit client for each one
Thanks for the video
You are welcome.
onclick="@(e => AddGuest(item))">Add Guest
onclick="@(e => UpdateGuest(item))">Update Guest
onclick="@(e => DeleteGuest(item))">Delete Guest
I follow step by step of this tutorial and
this onclick code give me this error "Cannot convert lambda expression to type "object" because it is not a delegate type".
any idea how to fix it? I already searching but cannot find a clue or the solution.
For those who are facing issues with POST and PUT requests, I solved mine by downgrading to version 5 of refit as a temporary fix. Apparently, version 6 implemented a different Json serializer causing requests with a [Body] to not work
Another solution I've seen is to add Buffered = True into your RefitSettings, but I still couldn't get it to work
Interesting. I'll look into it.
Since it's an interface you can also use it when unit testing Blazor.
Thanks for the tip
Good stuff, Thanks bro.
You are welcome.
Hi Tim, it's a great tutorial I have one question for you how would you unit test this? Many thanks
Thanks I used for frontend connect to Backend with Identity4.
Great!
Refit introduces too much magic that the team isn't fond of
If you go to their site, you can see exactly what Refit does (and it isn’t a ton - it basically just has us inherit from a base class).
Big thanks for this tutorial :), easily and brilliantly explained. I have a small questions, and if in the object there are elements of the Image or byte[] type, will there be no problem with downloading such data? i.e. how could I send and retrieve images and byte[]?
Usually this is done by converting the byte[] to Base64
Just wondering how do you react to different response status codes differently? Is this possible in Refit at all? Also is there an interface model generator from swagger.json? Hitting update on a generated NSwag client and fixing broken code is easy, going though 50+ classes looking for changes in an API you don't control is not fun. When all you get from a partner API is a swagger.json file and URL you need a generator.
Why do people is so lucky to get a swagger.json file? I always get very basic documentation in custom websites or (what is worse) PDFs 😔
@@anrodse Haha, I had to do that once, the endpoint was probably still running DOS and I had to roll the entire thing with just http calls and a lot of imagination. And every even the smallest API error invalidated future calls from the same client. Fun :D
You can deal with response status codes if you use Task as return type.
@@99MrX99 Sweet, thanks!
Good video. But I was hopping for something else. That you will call other API's like "Giphy API" "ricky and morty API" "restcountries API" and show results on swagger.
I give you the tools. You take them and create what you specifically need.
Struggling with more complex JSON that has a child object in it, for example attributes :{call time:10,calls:20}. On a POST body. The refit doesn’t seem to handle it well, any good example of how to deal with it
made some progress , but still need to figure out how to log the BODY of the POST, as something is not quite right. Logging /debugs with REFIT seems to be mystery in my searching
Thanks for explaining it so well Tim, I have recently used this library to call an API from a client(I am calling it API Client) but now when I want to test the API Client, I don't have the actual Api running with me, and would like to mock it out. but because behind the scene refit creates the httpclient factory, not sure how would I be able to mock it? any idea?
How does this compare to an autogenerated client from NSwag? I am currently using it in pretty much this setup, an API that I write and a Blazor client that I write.
It works, it generates a full client including types and everything. I don't need to do anything.
However it is not well documented and can be quite a headache to get working. Once it does, it does look strictly superior though. Especially if you have access to the API.
Its a little confusing to newer developers. Creating a Type in the API project, building it, then its "copied" to the Client project.
Im thinking maybe sticking to a fully blown NSwag client when I'm also the API Developer, but using this when its an external API. I tried to get NSwag to work with 2 external APIs and failed both times. This looks much easier, since its just route + type. It doesn't even need to be a swagger documented API.
Have you ever considered doing a series on how to use professional products like Dev Express or Telerik?
I have but I want to do it right, where it isn't just a sales tool but an actual value.
I'm not sure why. But the post request doesn't work for me I got an 400 error (.NET 6, I enabled cors on both API server and client)
I'm glad you got it to work.
I noticed that each of the interface methods start with Task. Is there a case where asynchronous calls would not be preferred? That is to ask, is there a reason why refit wouldn't build in the Task into their attributes?
Hello, what extension show attribute description (like "path:")?
In the Blazor project, how does it have access to GuestModel?
Each project has its own copy of GuestModel.
@@IAmTimCorey I have a question. If I´m consuming an API where I have a complex json response, how can I map my Models?
Is this any better then using the swagger client? Whats the pros and cons to using this over swagger
How does refit know the right post method on the api controller if there multiple post methods?
Each post method has its own URL. You can't have two POST methods use the same URL. So, you just tell Refit which URL you are calling and it does the rest.
How can we send Files using Refit.?
Thanks a lot. This looks great as it simplifies things quite a bit. But I have been wondering for years... Who is Sue Storm??? ;-)
One of the Fantastic Four (comic book/movie). I just use her name because it is short and easy to remember.
@@IAmTimCorey I always thought she was someone of your family 😅
Where would I do the cors in .net6 vs .net5 , it looks like there is no startup.cs now
(rookie)
This video should help: th-cam.com/video/vdhFw1VSowg/w-d-xo.html
And don't worry about being a rookie. We all are when it comes to .NET 6 changes. None of us have even 6 months of experience with the production version of .NET 6 yet.
I had a strange issue which I fixed, While creating the Interface I had copied the relative path for endpoints from swagger and build my client. But when I execute it I get 404 for the same endpoint which I can execute through swagger. The API url generated by Refit has urlencoded character "%E2%80%8B" - E2 80 8B - "ZERO WIDTH SPACE" values and API is returning 404 for it. After trying a lot, I just recreated the interface and the endpoint by typing in the url and it worked fine.. This wasted half a day of mine.
I'm glad you eventually figured it out.
Good library but not complete. I expect that I don't have to manually write interface with all methods signatures for api - they must be generated automatically, like in Swagger. All I need is to generate such class and use all methods without any manual api reflection
Hey Tim, I don't see that you have covered attributes, I don't understand how they work yet. Will you cover them in the future?
Yep, they are actually high on my list to cover.
@@IAmTimCorey can't wait, thanks.
I am second to watch this :)
Thank you!
You are welcome.
Can you made a tutorial for Refit on SOAP ?
I will add it to the list. Thanks for the suggestion.
In VS I noticed your screen displays Path: next it the [Get] in your interface, is that a Intelliense setup to display that?
You can enable that in Visual Studio by following this video (I put it at the right time code): th-cam.com/video/f0YeVirKPfw/w-d-xo.html
@@IAmTimCorey Thanks that is really helpful. And thanks for all the content. I love it.
What if ur dealing with a data context and ef multiple models not iust one interface
This doesn't really have anything to do with EF. Your API access shouldn't be tied directly to your data access, so how you set up EF would not be affected by your use of Refit (and the reverse is true as well).
When you remove the standard HTTPClient factory for the Refit HTTPClient one, do you loose any functionality or flexibility for working with HTTPClient stuff directly etc, or are the effects only additive, and everything else just works the way it would have?
It is the same HTTPClient, so no, you don't lose anything.
your older videos had hair in the thumbnail and now its gone.
Just like the hair on my head.
gr8
Thanks!
First
Fourth
Second
Third