Supercharging your Web APIs with OData and ASP.NET Core

[@richardholguin3481]

There are two types of developers, a LOT of stickers or NO stickers

[@chadmwest]

Truer words have never been spoken.

[@levinjay3376]

Hahah! :)

[@thilehoffer]

I have 3 stickers on my laptop.

[@gabrielmoreyra3365]

@Sharty Waffles Sure. That's why Jeremy is MVP and you're not.

[@gabrielmoreyra3365]

@Sharty Waffles I believe you they're experts. But I don't believe they got there by not sticking anything to their laptops.

[@robertkamenski9248]

Nice explanation by JSON Momoa!

[@69bitboy]

😂😂😂

[@PerryCodes]

HAHAHAHAHAHA. Thank you. I haven't laughed that hard in a while :)

[@HassanHabib]

LOL

[@navdeepsingh9463]

😂

[@fabienl.7569]

Who needs GraphQL when you have OData ? Wonderful! 🙌

[@bryanwood9965]

I always love Remote Code Execution

[@userdfourdfive1788]

This is great for simple solutions where EF context is tightly coupled to API. What about solutions that have a core project with domain models, services and repositories and where every piece is resolved dynamically when the solution is running?

[@yaynative]

I love when standards are open and powerful.

[@saravanansomu8296]

This is a great way to explain OData. Loved the grocery store analogy. thanks.

[@F2H16]

Thanks, Hassan and Jeremy for such a nice intro.

[@mihirp8013]

Thanks for making OData super easy to implement with core! Can’t wait to add additional “4 Lines of Code” to all my API projects. 👍🏻

[@Night3scape]

Amazing, thanks a lot. that was amazing intro, now I need to figure out how to integrate it with ASPCore Policy Based Authorization, to control Entity extending and other OData Features..

[@RaviMittal84]

I have a question, Does that Odata operations happening directly on Database OR it's happening afterwards on the result set??

[@HassanHabib]

If your return type is an IQueryable it runs on the database.

[@ibrahimozgon]

medium.com/@ibrahimozgon/asp-net-core-odata-query-database-over-url-820624beef92

[@aah134-K]

@@HassanHabib ya habib How about if it is entity framework?

[@HassanHabib]

@@aah134-K if you materialize your data coming from EF as a list then it runs in memory, if you run on an IQueryable DataSet in EF then it runs on the database.

[@odairto]

@@HassanHabib I did it and the SQL intercepted its a full SQL. This is my github, if you want to see: github.com/odairto/ODataEF

[@hck1bloodday]

great lternative to the current trend of GraphQL, and i really like this approach , with graphQl you overfetch from the db nd filter on the server, this uses Entity framework to filter in the database

[@marcel830]

You misunderstood GraphQL. You can also use the Entity Framework to filter in the DB.

[@hck1bloodday]

@@marcel830 sure, but you have to spicify the queries that will apply those filters, then you loose the benefict over rest

[@cmcki2008]

This got to be the best video I’ve seen while working in IT. Thank you 😊

[@HassanHabib]

Thank you for watching :-)

[@BrendanKnowles]

Hassan, you're a legend - this is exactly what I was looking for!

[@HassanHabib]

Thank you Brendan, I think the legends are the visionaries and engineers behind this technology, I'm just trying to bring their amazing work to light.

[@abhishekbedre]

If you notice, the response without the $expand and $filter the API follows the camelCase and once you add the $filter or $expand it omits the default camelCase.

[@ASPCook]

I've seen a company that used OData in a large size application. And I only have one advise about it: OData or even GraphQL are good if you can chuck your application to small size services or you will close the door of updating your project to newer technolgies forever. Then the life will be so hard! :D

[@matiascasagrande7759]

Is there a way to inject the OData filtering capabilities outside the Controller? Like in a Service layer perhaps?

[@LogicLabyrinth]

I wonder if this implementation is paving the way for support for GraphQL, or will it always be a divergent solution? At minimum, definitely a promising addition for standard APIs.

[@HassanHabib]

OData actually existed before GraphQL, in fact OData is a lot more powerful than GraphQL check out the comparison here: www.progress.com/blogs/rest-api-industry-debate-odata-vs-graphql-vs-ords

[@balramsingh4759]

Very well explained, thanks

[@RemusTMUTHOMI]

Great demo 👍👏, worth every second

[@rans0101]

Great, thank you Hassan!

[@Robinhopok]

Really interesting. Are there any libraries which make generating Typescript clients possible? I'm also curious if OData can be used for add/update/delete operations. I guess I'll check out the docs!

[@HassanHabib]

Of course, we will be discussing this in detail in an upcoming videos.

[@sugeshangovindsamy6220]

Wow !!! So you can code and be the best football player in the world 🤣🤣🤣🤣🤣

[@BenHayat]

Two great guys.

[@rongliao9255]

Great tutorial! Thanks a lot!

[@julioalmeida4645]

Show now an integration of OData with Swagger and you will have my slow clap

[@mspasiuk]

Same here, I added the OData to my controller, and works, but swagger don't. Im using net core 2.1

[@HassanHabib]

@@mspasiuk I'm working with the OData team to get this officially released - should be out officially shortly.

[@vincentnwonah7637]

@Hassan Habib Thanks!

[@aah134-K]

🤣🥳🥳🥳

[@erichughes1460]

i did it at work this month ;)

[@DutchThought]

When can we plug this into 3.1? Great work.

[@offline_meetup]

I didn't test it yet, but here is an article from Hassan about OData in asp.net core 3.1 devblogs.microsoft.com/odata/experimenting-with-odata-in-asp-net-core-3-1/

[@bullsinhell]

Hassan - First of all, a really cool demo. Is it possible to use the above with a return type as HttpResponseMessage for my Get action (.NET Core 2.0 - Web API)?

[@mkraft467]

Thanks guys amazing demo. But I have one question which I am having a hard time to figure out: is it possible to have both the existing WebAPI and the OData service leaving side by side but to access it with a different prefix like this ? api/Students -> WebAPI odata/Students -> OData I am using .NET 6 / AspnetCore.OData 8

[@xelaksal6690]

Magic:) Thank you for this demo.

[@arturoescutialopez1900]

It would be great than you could map queried data to a DTO, for me It's not quite a good idea to allow your whole entity structure be shown to clients

[@Emis333]

You can create automappers to map your model structure to a viewmodel structure where you show just enough.

[@mkraft467]

Automapper and projection is working very well with OData and EFCore

[@12SecondsToLive]

The end of video mention it works with Classic ASP.NET, I assume that's ASP.NET WebAPI .NET Framework? Is there an example setting that up?

[@HassanHabib]

Yup, that's exactly what I meant, in fact it's even simpler in ASP.NET Web API with .NET Framework, you still gonna have to add OData service, but then you don't have to do the dependency injection part, just add [EnableQuery] to your controller and you should be good to go!

[@HassanHabib]

Here's an example: kzbin.info/www/bejne/qJK1dIhoqMd3ick

[@Ashwath-p8c]

Nice video! 2 questions. 1. If I have a response like this { id:"123", "metadata": { "branch": "master" } }, { id:"1234", "metadata": { "branch": "master" } }, { id:"1235", "metadata": { "branch": "master1" } }, how do I $select just the branch property? 2. How can i select only the distinct branches? (master and master1 in this case?)

[@satish8000518289]

Thank you Friends. it was awesome experience. I have worked with repository patten in that case what i can do.

[@HassanHabib]

Still works, as long as your repository object returns an IEnumerable or IQueryable.

[@guillermoacosta8849]

Hi @ Hassan Habib! Great video and explanation! Thank you! I have a question: to practice, I'm play around Chinook databases (do you know?), and "expand" don't work for me, using it like you in your video. The result json show the value items like [ ]. The relation on databases through foreing key, indexes, etc are fine. Summarizing, it does not show the values tied by navigation properties. Please, can you give me any clue that may be failing? Thanks in advance!

[@Surenzzzaaa]

Thank You...

[@jo0h4n18]

If you're having an api which executes an specific store procedure for that specific endpoint, then you can change the output by altering the store procedure right? This can be done without having to build and release an new version of the api that now needs a new functionality to the routebuilder.

[@subhashmishra2326]

Nicely explained.. Awesome..Thanks a lot!

[@borschetsky]

Amazing! Thank you a lot!

[@Emis333]

That's an amazing capability, good to know :)

[@stelathsyncllc1085]

Really good stuff. Thank you.

[@hamedmohammadi1398]

wow, i think MS really should focus on trending this stuff, this is like graphql but has been around since 2007, yet everybodey just talk about graphql and how its gonna change the world but it came to play in 2015

[@dhanushkakodituwakku5165]

What's the best approach to make it case insensitive?

[@JH-qe3fu]

Answer is?

[@tarakpatel85]

$count is not working with endpoints.EnableDependencyInjection();, it works without and adding routeBuilder.MapODataServiceRoute("ODataRoute", "odata", GetEdmModel(app.ApplicationServices)); in .UseMvc(). Any suggestion how $count work with endpoints.EnableDependencyInjection()?

[@WholeNewLevel2018]

this is simply amazing

[@tuhamustefa6588]

WoW, it's super Amazing

[@ingamx]

thats really good. tnx

[@sehulugh]

Wow, I got an Api to add a few lines of code and a client App to rebuild, thanks

[@LinusBenjamin]

Great stuff! Thanks a lot!

[@userdfourdfive1788]

Is there some possibility with the Expand feature to expand to only one level of relationship and not unlimited levels. This will prevent the user to query the whole database.

[@idgafa]

[EnableQuery(MaxExpansionDepth = 1)]

[@EaswaranParamasivam]

It saves more time.. thanks!

[@gleamofcolor]

Those 4 lines of code did work in .net core 3.1 . I have to do other config changes as well. Pls update this video with latest .net core version at least 3.1 onwards

[@arunkumarparthasarathy6424]

Superb

[@ThoNguyen-ns6jh]

good job, thanks

[@cyril113]

The funny thing is, the initial JSON response had lower case keys and the OData responses capital case keys. Pascal case is just weird.

[@acidfoxx52]

What reference is being used that is not part of the "4 lines" of code?

[@mhawkpiece]

Awesome!!

[@joshmccall]

Great video!

[@puravupadhyay2961]

When a another REST API is consumed by a Web API, is it a good idea to use OData?

[@klfr2900]

Isn´t OData also about the format, not only how to query the data? Does this also comes with the ASP.NET Core OData Package, how many lines of code would it took to add that? :)

[@DunckingTest]

omg this is awsome maaaagic

[@kalaiselvanra]

Interesting stuff.

[@yanaraldaghestani6305]

amazing

[@akuhndevelopers1989]

Supper amazing!!

[@ismaegonzales5]

Esto me ayuda mejorar 🎉😊

[@kafoly1980]

Just a remark. Don't confuse expand and navigation this is not exactly the same concept: - expand : you get the root entity (student) and related entity(school) in one request by giving the name of navigation in the expand parameter. So expand is based on navigation. - navigation: You get additional information on the root entity by calling a navigation on another entity (and target property). This additional information will trigger another request than the primary request on the root entity.

[@DennisTuckersAwesome]

Is there a git repo for this example?

[@ibrahimozgon]

Does OData query on DB via Entity framework or does it only query on the results?

[@HassanHabib]

It depends on the return type, if your controller method is returning a IEnumerable it will perform differently than if it was returning IQueryable. if it's IQueryable OData will perform the search on the database via EF, if it's IEnumerable it will perform the query on the returned results. hope this helps.

[@ibrahimozgon]

@@HassanHabib This is great answer and really great feature. Thank you for the very informative video

[@davidpereira6982]

@@HassanHabib This is awesome, because I guess most of ASP.NET Core APIs return IEnumerables from the injected services in the controllers. If you only need 4 lines of code to do all of this, it's f*cking magic! I would like to know how performance is affected with OData, but so far it's quite impressive. Thank you guys, loving all your stuff you are doing and I really hope .NET Core 3 will be a boom in the Software Development world.

[@Lan0NT]

Great. How to working odata with unit of work?

[@HassanHabib]

What do you mean? please elaborate.

[@alexandershubert573]

Amazing, how now with .net 6 all of this needs to be re-recorded

[@KarlRhodesUK]

Cool... Now how do I use consume an OData service in ASP.Net Core 3?

[@kristjankica7471]

Not compatible with 3.0

[@emaung]

Guys how can exposing the whole dbContext in controller to the world is the good idea?

[@matiascasagrande7759]

That is exactly what im asking to myself, also i just asked if there is a way to pass the filter options to an underliying layer like a Service Layer to perform the filtering in that layer and not in the controller

[@UnrealSPh]

Hi! Good video, thank you! What about restier for asp.net core?

[@HassanHabib]

Thank you for watching, we will try to address that.

[@Turbosmurfen73]

Love it!

[@brunoccs]

Is it affecting the database query or just the return from the API?

[@HassanHabib]

If you're returning an IQueryable, it will run on the database.

[@consolednd]

For the secure reason, I don't want to share full entity from DataContext. Can I use OData for IQueryable instead of an entity?

[@HassanHabib]

Yes of course, you have full control over your return type on the controller method.

[@UniversB3]

Très belle démonstration d'OData, Merci. J'aurai bien aimé savoir comment et surtout à quelle moment les données sont traités (filtre, select,... ) Est ce que c'est vraiment au moment de l'exécution de la requête dans la base de données où une fois remontée, mais ça reste en mémoire côté serveur ? Merci beaucoup

[@baris7971]

oData is great. But sadly it breaks Swagger API Doc. Is there any Workaround for this behaviour?

[@MrKhaledpage]

well explained!

[@JuanDavidMaya]

if a want to have this automatically for every table in my database how I could achieve this without using Entity Framework and map every table manually?

[@SasanSalem]

Do it bring all list into ram and process it in ram? Or query applied on Database? Its very important!

[@HassanHabib]

If you're running against an IQueryable, it will all run on the database.

[@SasanSalem]

@@HassanHabib that's great. thank you very much.

[@rcardare]

Needs more dynamic/non-sqlserver/large dataset examples. I had to pass on this framework as it wasn't abstract enough for a simple json response. Current framework should be filed under the EF namespace and not a standalone product.

[@HassanHabib]

That's not true actually, you can build a simple controller that returns a hardcoded list of values and OData will still query and filter - not EF specific.

[@rcardare]

​I'll try it out again as I am sure things improved. Last I remember only small tables in sql were really supported, everything else killed performance or required a lot of work to implement custom EF providers in .net core. I am working on a system to abstract old databases (sql, oracle, etc) and some instances are very old and large. I had problems the last time I researched this so maybe it worth checking out again. Thanks

[@HassanHabib]

@@rcardare let us know how it goes.

[@sandeeepbandaru]

This looks interesting. I was trying to add routeBuilder to - app.UseWebApi() ( my app uses this). But I am not able to pass the routeBuilder predicate to this. Can someone help me out please?

[@HassanHabib]

Could elaborate more? what are you trying to do?

[@sandeeepbandaru]

@@HassanHabib In Startup Configure(IAppBuilder) -> i am using app.UseWebApi(config) instead of UseMvc. And UseWebApi does not have routebuilder as argument. Can we somehow make this work with webapi as well?

[@HassanHabib]

@@sandeeepbandaru I see. if you're okay with going to 6 lines of code instead of 4 - you can do this: gist.github.com/hassanhabib/a63297a55e802157b353525c9d420363

[@somebodytocode]

impressive

[@bobbyv3]

Are those 13 or 15" Surface Book 2s?

[@HassanHabib]

15" :-)

[@elgunlee]

Hi. I hava a question. Is routeBuilder.EnableDependencyInjection(); required? As far as I know we can already use DI in controllers without writing this.

[@HassanHabib]

Yes, it's required for your non-Edm route

[@joelmamedov404]

Well, if you want the client-side capability more than service end-point can provide, then, in essence, you need to write SQL type query. To do that, you need to know the data schema of the source system. If you are going to that direction, then I would question the whole idea of the service concept and service encapsulation.

[@TPersistent]

Should not be taken lightly. Seems like a way to open up endpoints to denial of service attacks.

[@HassanHabib]

True, and OData comes with it's own measures of security, although, nothing is ever exactly perfect, but adding a control over the existing web api security makes it much more secure than it's alternatives.

[@ozkanb]

Rate limiting on gateway level can solve that problem

[@bangonkali]

for smallscale deployments use of services such as cloudflare's will hugely protect dns endpoints for only 20usd/mo at the basic level. it adds another layer of protection. but definitely there are other leet ways to protect at different layers of your stack. this is just one of the ways ddos can be mitigated. many more ways.

[@thilehoffer]

Does this work with .net Core 3.0?

[@HassanHabib]

Yes, here's how to do it: devblogs.microsoft.com/odata/experimenting-with-odata-in-asp-net-core-3-1/ and here as well: devblogs.microsoft.com/odata/enabling-endpoint-routing-in-odata/

[@ashfaqshaikh7041]

Is it also available in asp.net web or mvc framework

[@HassanHabib]

Yes, here's an example: kzbin.info/www/bejne/kHSniIh4hK9ofLc

[@lestersantiago510]

Can certain capability be required per service? Like, api/Students needed to be filtered or paged?

[@HassanHabib]

As long as it's an API then it's OData-capable :-)

[@lestersantiago510]

@@HassanHabib my question isn't clear. Let me try it again. If the filter has been enabled via Startup.cs, can it be required per endpoint. In the case of api/Students, filter must be supplied, else it'll throw an error. Is that possible?

[@HassanHabib]

I see what you're saying, yes you can make it per endpoint by passing a paramter through the [EnableQuery()] annotation that I used in the demo, for instance you can say: [EnableQuery(AllowedQueryOptions = Microsoft.AspNet.OData.Query.AllowedQueryOptions.Expand)] so this way you're only allowing expand but not anything else, there are more things you can do with the EnableQuery annotation to do a per-endpoint control work, does that answer your question?

[@lestersantiago510]

@@HassanHabib Yes, you definitely did. Thank you. This will be really nice. This means that even though an IQueryable must be returned in order to run the query in the DB, it can prevent getting unfiltered data by requiring the endpoint to supply a filter. Cool stuff. 👍

[@adriancamposteixeira5483]

thanks json momoa

[@jacobneroth]

Out of context , how you do map open types in odata to entity framework core ?

[@anomepani]

Where we can find source code which you have given in Demo?

[@HassanHabib]

Right here: github.com/hassanhabib/ODataDemo

[@MichaelRosendahl2013]

Nice demo, specially if you have an open API, but is there any way to map queries to DTOs and more importantly use AuthorizationHandler?

[@DavidRodriguezDev]

For those who want this on NetCore 3 this is the current state (as today) github.com/xuzhg/WebApiSample/tree/master/AspNetCore3x/AspNetCoreOData3x Its seems to be working now but using synchronous operations

[@ZeVS777]

Interesting if I can do that with Dapper on SQL server... And also it would be great to have explanations for net core 3.0

[@HassanHabib]

We will make more videos around the subject and touch on net core 3.0

[@muhammadfaridahamat8838]

@@HassanHabib One year on, do you have video on this subject? Can you share here if you do, I can't find anything on this.

[@andreigalkin]

Hey. Is any one seen a recent example how to unit test a controller with ODataQueryOptions filter. I am having a trouble to create it of mock it. All example which i found do not work with the .net 5. Thanks

[@dotnetdevni]

What about auto lookup the schools against the school name

[@HassanHabib]

You can using filtering to do that, so you can do $filter=Name eq 'School Name Here' something like that.

[@GregerHagstrom]

Hassan didn't go to the "amount of stickers" meeting

[@HassanHabib]

LOL

[@rokinroj]

I need to talk about your flair. Now, it's up to you whether or not you want to just do the bare minimum. Well, like Jeremy, for example, has 37 pieces of flair.

[@HassanHabib]

@@rokinroj "I do want to express myself. And I don't need thirty-seven pieces of flair to do it. " Haha

[@kuttikrishnankodoth1463]

Awesome ...!!! Can I Integrate with Dapper and Oracle Database.? Thank you !!!!!

[@HassanHabib]

Yes, you can integrate with any data source you want.

[@kuttikrishnankodoth1463]

@@HassanHabib Thanks much for your kind response.

[@kuttikrishnankodoth1463]

@@HassanHabib But.... how, daper dont return an IQueryable , only thing we can do is to convert IEnumerable to Iqueryable which kills the purpose of it, i want to execute the query from database than in memory. are you suggesting doing an in memory operation ? the data which i am planning to churn is huge amount and is in oracle db.. Kindly advise ..

[@HassanHabib]

@@kuttikrishnankodoth1463 abstract your data layer and OData will take care of the rest on the controller level.

[@HassanHabib]

@@kuttikrishnankodoth1463 Dapper isn't meant to appeal to those who wanna query from code, it's meant for those who love SQL, and this is why they intentionally dont support interfaces for IQueryable. I would wonder if doing an AsQueryable on your IEnumerable would make any difference? If not check out some of the solutions here: stackoverflow.com/questions/11685830

[@ericjhuneespa3381]

When i use odata with async task await . . using the expand .. it is not working why ??