Support Minimal API #1140

xuzhg · 2023-12-15T04:18:44Z

Fixes #578

Minimal APIs are a simplified approach for building fast HTTP APIs with ASP.NET Core. You can build fully functioning REST endpoints with minimal code and configuration. Skip traditional scaffolding and avoid unnecessary controllers by fluently declaring API routes and actions. For example, the following code creates an API at the root of the web app that returns the text, "Hello World!".

var app = WebApplication.Create(args);
app.MapGet("/", () => "Hello World!");
app.Run();

Customer want to get the OData query options functionalities. We can provide couple solutions

Get OData JSON payload for minimal API
Enable customer to apply OData query to IQueryable explicitly.
Enable customers to apply OData query to IQueryable implicitly.

habbes · 2024-01-04T08:53:23Z

Happy to see some progress on minimal API support @xuzhg
Would you consider adding more context or a more detailed breakdown of the PR implementation?

Also can you clarify the extent of OData features we support in this PR and what do not support (and do not plan to support).
I assume OData routing is not supported at all. Does this support model binding? Delta? Or is support restricted to only ODataQueryOptions<T>?

xuzhg · 2024-01-04T20:12:55Z

Happy to see some progress on minimal API support @xuzhg Would you consider adding more context or a more detailed breakdown of the PR implementation?

Also can you clarify the extent of OData features we support in this PR and what do not support (and do not plan to support). I assume OData routing is not supported at all. Does this support model binding? Delta? Or is support restricted to only ODataQueryOptions<T>?

Thanks for your feedback. Actually, the product codes in the PR changed less.

OData routing

In my understanding, most of customers only want to get the 'OData Query functionalities" when building the minimal API. They don't want to know "Entity Type, Complex Type", or "Entity set, Singleton, Navigation Source, Navigation Property", concepts like these. Even thought they don't want to know about "Key Segement" and It should come after "Collection Segement". So, there's no "OData routing" at all. However, we can add "OData routing" mechanise, for example:

app.MapOData<ODataServiceContext>(EdmModel);

Where, ODataServiceContext is a class containing OData routings.

Does this support model binding?

In my understanding, ASP.NET Core doesn't add model binding for minimal API. So we can't add it. In the minimal API, it only contains the parameter binding, it's same as "model binding" and most of logics are same. For example, You can put [FromBody] on the parameter to bind the parameter from request body. There's new solution to customize the parameter binding. That's what I used in my PR to binding the ODataQueryOptiont< T >.

Delta< T > ? DeltaSet< T >

I think we should support to bind those types. I also added the comments in my PR to support them. It could be a little bit same as ODataQueryOption< T > implementation. It's not complicated but I think let's do it step by step. Before implementing it, let's finish our first BrainStorm on the initial design.

To Be Discussion

OData payload is JSON payload. I think it's time to consider to use Default Json serializer/deserializer. The only thing is to implement the JsonConverter on the OData object. We can sync it more later.

julealgon · 2024-01-16T21:48:35Z

OData payload is JSON payload. I think it's time to consider to use Default Json serializer/deserializer. The only thing is to implement the JsonConverter on the OData object. We can sync it more later.

Honestly... this would be the biggest improvement to OData in years and would avoid so many problems.

At the same time... seems ambitious to consider that alongside the Minimal API changes 😅. As much as I want that, I'd avoid doing them together, or potentially even in the same release.

robertmclaws · 2024-01-17T02:08:49Z

It would be ABSOLUTELY AMAZING if OData switched to out-of-the-box System.Text.Json serialization with converters. I think it would improve perf by at least 50%, and I wouldn't be surprised if you saw a 200-400% improvement.

Probably needs a separate work branch tho. Hopefully the unit tests are designed to be able to handle this.

Happy to help wherever possible.

habbes · 2024-01-17T06:47:11Z

I agree we stand to gain a lot from leveraging System.Text.Json. But it's not a trivial change given all the scenarios that OData's current serialization supports as well as adherence to the OData spec. However, this is something we're currently looking into. I'll share results from the progress soon. (see: OData/odata.net#2798)

habbes

Will you add tests?

habbes · 2024-01-19T04:40:00Z

sample/ODataMiniApi/MetadataHandler.cs

+
+namespace ODataMiniApi;
+
+public class MetadataHandler


Given that this is in the sample project, does this mean this is something the customer will have to write, or does this work out of the box?

habbes · 2024-01-19T04:40:39Z

sample/ODataMiniApi/MetadataHandler.cs

+            SkipValidation = false
+        };
+
+        // we can't use response body directly since ODL writes the JSON CSDL using Synchronous operations.


Should we prioritize making this async in ODL?

habbes · 2024-01-19T04:59:45Z

sample/ODataMiniApi/Program.cs

+app.MapGet("/customized/schools", (AppDb db, ODataQueryOptions<School> options) => {
+    db.ChangeTracker.QueryTrackingBehavior = QueryTrackingBehavior.NoTracking;
+    return options.ApplyTo(db.Schools);
+}).UseOData("customized"); // In customized OData, MailAddress and Student are complex types, you can also use 'IODataModelConfiguration'


How would you use IODataModelConfiguration?

habbes · 2024-01-19T05:25:47Z

src/Microsoft.AspNetCore.OData/Edm/IODataModelConfiguration.cs

+        /// </summary>
+        /// <param name="context">The HttpContext.</param>
+        /// <param name="builder">The <see cref="ODataModelBuilder">builder</see> used to apply configurations.</param>
+        void Apply(HttpContext context, ODataModelBuilder builder);


Do we envision that more arguments could be needed in the future, such that we could use an ODataModelConfiguratonOptions class to encapsulate the options, or is an ODataModelBuilder sufficient?

habbes · 2024-01-19T05:42:56Z

src/Microsoft.AspNetCore.OData/Query/Wrapper/SelectExpandWrapperConverter.cs

    /// Supports converting <see cref="SelectExpandWrapper{T}"/> types by using a factory pattern.
    /// </summary>
-    internal class SelectExpandWrapperConverter : JsonConverterFactory
+    public class SelectExpandWrapperConverter : JsonConverterFactory


Why is this made public?

habbes · 2024-01-19T05:50:40Z

src/Microsoft.AspNetCore.OData/Edm/IODataEndpointModelMapper.cs

+    /// A cache for <see cref="Endpoint"/> and <see cref="IEdmModel"/> mapping.
+    /// It's typically used for minimal API scenario.
+    /// </summary>
+    public interface IODataEndpointModelMapper


What is the likelihood that the customer will want to customize this? Maybe we should make it internal until there's explicit/clear demand from the customer to make it extensible, that way it can give us room to change the design without breaking changes.

danielpastoor · 2024-02-09T10:48:41Z

Is there any update on this pull-request?

cbrianball · 2024-08-28T16:54:30Z

Can this please be merged?! I would really like to use minimal API with OData!

cbrianball · 2024-08-29T15:38:08Z

One thing I have noticed is that the response from the minimal API endpoints just have the "bare" data. Meaning it doesn't have "@odata.context" field and then the result in a "value" field. If there is a way to have this, please include an example.

julealgon · 2024-08-29T16:37:59Z

One thing I have noticed is that the response from the minimal API endpoints just have the "bare" data. Meaning it doesn't have "@odata.context" field and then the result in a "value" field. If there is a way to have this, please include an example.

That's likely unintentional. That response body is a critical part of the OData protocol and needs to be kept intact.

asyncoder · 2024-09-28T10:15:18Z

Any updates on this?

mike-bagheri · 2024-10-08T02:45:52Z

Any new on this one? Is there any plan to release this?

mguinness · 2025-01-31T00:33:42Z

@xuzhg It's been a year since you last worked on this PR, are there any blockers? @mikepizzo The original issue has 28 upvotes, is this something that is considered?

EDIT: See new PR #1431

xuzhg added 2 commits December 14, 2023 20:07

fixes #578: Support minimal API

e302c8c

add more scenarios into readme.md

182f203

xuzhg requested review from ElizabethOkerio, KenitoInc, gathogojr, habbes and mikepizzo December 15, 2023 04:18

Enable OData metadata endpoint.

a673bed

cilerler approved these changes Jan 5, 2024

View reviewed changes

habbes reviewed Jan 19, 2024

View reviewed changes

Support Minimal API #1140

Are you sure you want to change the base?

Support Minimal API #1140

Uh oh!

Conversation

xuzhg commented Dec 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

habbes commented Jan 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xuzhg commented Jan 4, 2024

OData routing

Does this support model binding?

Delta< T > ? DeltaSet< T >

To Be Discussion

Uh oh!

julealgon commented Jan 16, 2024

Uh oh!

robertmclaws commented Jan 17, 2024

Uh oh!

habbes commented Jan 17, 2024

Uh oh!

habbes left a comment

Choose a reason for hiding this comment

Uh oh!

habbes Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

habbes Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

habbes Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

habbes Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

habbes Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

habbes Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

danielpastoor commented Feb 9, 2024

Uh oh!

cbrianball commented Aug 28, 2024

Uh oh!

cbrianball commented Aug 29, 2024

Uh oh!

julealgon commented Aug 29, 2024

Uh oh!

asyncoder commented Sep 28, 2024

Uh oh!

mike-bagheri commented Oct 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mguinness commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

xuzhg commented Dec 15, 2023 •

edited

Loading

habbes commented Jan 4, 2024 •

edited

Loading

mike-bagheri commented Oct 8, 2024 •

edited

Loading

mguinness commented Jan 31, 2025 •

edited

Loading