You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copilot backlog handling: Fix authorId → author route parameter name mismatch in custom-model-binding article (#36793)
* Initial plan
* Fix authorId route parameter name mismatch in custom-model-binding.md
Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
* Add ai-usage: ai-assisted metadata to custom-model-binding.md frontmatter
Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
* Apply suggestions from code review
Edit pass on AI gen content for the PR. Clarified a few sectons and updated to latest standardization on notes and few others from the original doc.
* Apply suggestions from code review
* Apply suggestions from code review
Fixes per review feedback.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
Co-authored-by: Wade Pickett <wpickett@microsoft.com>
You can POST a base64-encoded string to the previous api method using a tool like [curl](https://curl.haxx.se/).
63
+
You can POST a base64-encoded string to the previous API method using a tool like [curl](https://curl.haxx.se/).
63
64
64
65
As long as the binder can bind request data to appropriately named properties or arguments, model binding will succeed. The following example shows how to use `ByteArrayModelBinder` with a view model:
In this section we'll implement a custom model binder that:
71
+
In this section, we'll implement a custom model binder that:
71
72
72
73
* Converts incoming request data into strongly typed key arguments.
73
74
* Uses Entity Framework Core to fetch the associated entity.
@@ -79,12 +80,12 @@ The following sample uses the `ModelBinder` attribute on the `Author` model:
79
80
80
81
In the preceding code, the `ModelBinder` attribute specifies the type of `IModelBinder` that should be used to bind `Author` action parameters.
81
82
82
-
The following `AuthorEntityBinder` class binds an `Author` parameter by fetching the entity from a data source using Entity Framework Core and an `authorId`:
83
+
The following `AuthorEntityBinder` class binds an `Author` parameter by using the `author` route value to fetch the entity from a data source with Entity Framework Core:
> The preceding `AuthorEntityBinder` class is intended to illustrate a custom model binder. The class isn't intended to illustrate best practices for a lookup scenario. For lookup, bind the `authorId` and query the database in an action method. This approach separates model binding failures from `NotFound` cases.
88
+
> The preceding `AuthorEntityBinder` class is intended to illustrate a custom model binder. The class isn't intended to illustrate best practices for a lookup scenario. For lookup, bind the `author` parameter directly and query the database in an action method. This approach separates model binding failures from `NotFound` cases.
88
89
89
90
The following code shows how to use the `AuthorEntityBinder` in an action method:
90
91
@@ -94,7 +95,7 @@ The `ModelBinder` attribute can be used to apply the `AuthorEntityBinder` to par
In this example, since the name of the argument isn't the default `authorId`, it's specified on the parameter using the `ModelBinder` attribute. Both the controller and action method are simplified compared to looking up the entity in the action method. The logic to fetch the author using Entity Framework Core is moved to the model binder. This can be a considerable simplification when you have several methods that bind to the `Author` model.
98
+
In this example, since the route parameter name (`id`) doesn't match the action method parameter name (`author`), the `Name` property on the `ModelBinder` attribute is used to specify which route value to bind. Both the controller and action method are simplified compared to looking up the entity in the action method. The logic to fetch the author using Entity Framework Core is moved to the model binder. This can be a considerable simplification when you have several methods that bind to the `Author` model.
98
99
99
100
You can apply the `ModelBinder` attribute to individual model properties (such as on a viewmodel) or to action method parameters to specify a certain model binder or model name for just that type or action.
100
101
@@ -104,7 +105,7 @@ Instead of applying an attribute, you can implement `IModelBinderProvider`. This
> The preceding code returns a `BinderTypeModelBinder`. `BinderTypeModelBinder` acts as a factory for model binders and provides dependency injection (DI). The `AuthorEntityBinder` requires DI to access EF Core. Use `BinderTypeModelBinder` if your model binder requires services from DI.
109
110
110
111
To use a custom model binder provider, add it in `ConfigureServices`:
@@ -200,12 +201,12 @@ The following sample uses the `ModelBinder` attribute on the `Author` model:
200
201
201
202
In the preceding code, the `ModelBinder` attribute specifies the type of `IModelBinder` that should be used to bind `Author` action parameters.
202
203
203
-
The following `AuthorEntityBinder` class binds an `Author` parameter by fetching the entity from a data source using Entity Framework Core and an `authorId`:
204
+
The following `AuthorEntityBinder` class binds an `Author` parameter by fetching the entity from a data source using Entity Framework Core and an `author` route value:
> The preceding `AuthorEntityBinder` class is intended to illustrate a custom model binder. The class isn't intended to illustrate best practices for a lookup scenario. For lookup, bind the `authorId` and query the database in an action method. This approach separates model binding failures from `NotFound` cases.
209
+
> The preceding `AuthorEntityBinder` class is intended to illustrate a custom model binder. The class isn't intended to illustrate best practices for a lookup scenario. For lookup, bind the `author` parameter directly and query the database in an action method. This approach separates model binding failures from `NotFound` cases.
209
210
210
211
The following code shows how to use the `AuthorEntityBinder` in an action method:
211
212
@@ -215,7 +216,7 @@ The `ModelBinder` attribute can be used to apply the `AuthorEntityBinder` to par
In this example, since the name of the argument isn't the default `authorId`, it's specified on the parameter using the `ModelBinder` attribute. Both the controller and action method are simplified compared to looking up the entity in the action method. The logic to fetch the author using Entity Framework Core is moved to the model binder. This can be a considerable simplification when you have several methods that bind to the `Author` model.
219
+
In this example, since the route parameter name (`id`) doesn't match the action method parameter name (`author`), the `Name` property on the `ModelBinder` attribute is used to specify which route value to bind. Both the controller and action method are simplified compared to looking up the entity in the action method. The logic to fetch the author using Entity Framework Core is moved to the model binder. This can be a considerable simplification when you have several methods that bind to the `Author` model.
219
220
220
221
You can apply the `ModelBinder` attribute to individual model properties (such as on a viewmodel) or to action method parameters to specify a certain model binder or model name for just that type or action.
221
222
@@ -225,7 +226,7 @@ Instead of applying an attribute, you can implement `IModelBinderProvider`. This
> The preceding code returns a `BinderTypeModelBinder`. `BinderTypeModelBinder` acts as a factory for model binders and provides dependency injection (DI). The `AuthorEntityBinder` requires DI to access EF Core. Use `BinderTypeModelBinder` if your model binder requires services from DI.
230
231
231
232
To use a custom model binder provider, add it in `ConfigureServices`:
0 commit comments