Skip to content

Commit a56e782

Browse files
Copilotwadepickett
andauthored
Copilot backlog handling: Fix authorIdauthor 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>
1 parent f441243 commit a56e782

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

aspnetcore/mvc/advanced/custom-model-binding.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
title: Custom Model Binding in ASP.NET Core
3+
ai-usage: ai-assisted
34
author: tdykstra
45
description: Learn how model binding allows controller actions to work directly with model types in ASP.NET Core.
56
ms.author: tdykstra
6-
ms.date: 04/03/2024
7+
ms.date: 02/23/2026
78
uid: mvc/advanced/custom-model-binding
89
---
910
# Custom Model Binding in ASP.NET Core
@@ -59,15 +60,15 @@ The following example shows how to use `ByteArrayModelBinder` to convert a base6
5960

6061
[!code-csharp[](custom-model-binding/samples/3.x/CustomModelBindingSample/Controllers/ImageController.cs?name=snippet_Post)]
6162

62-
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/).
6364

6465
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:
6566

6667
[!code-csharp[](custom-model-binding/samples/3.x/CustomModelBindingSample/Controllers/ImageController.cs?name=snippet_SaveProfile&highlight=2)]
6768

6869
## Custom model binder sample
6970

70-
In this section we'll implement a custom model binder that:
71+
In this section, we'll implement a custom model binder that:
7172

7273
* Converts incoming request data into strongly typed key arguments.
7374
* Uses Entity Framework Core to fetch the associated entity.
@@ -79,12 +80,12 @@ The following sample uses the `ModelBinder` attribute on the `Author` model:
7980

8081
In the preceding code, the `ModelBinder` attribute specifies the type of `IModelBinder` that should be used to bind `Author` action parameters.
8182

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:
8384

8485
[!code-csharp[](custom-model-binding/samples/3.x/CustomModelBindingSample/Binders/AuthorEntityBinder.cs?name=snippet_Class)]
8586

8687
> [!NOTE]
87-
> 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.
8889
8990
The following code shows how to use the `AuthorEntityBinder` in an action method:
9091

@@ -94,7 +95,7 @@ The `ModelBinder` attribute can be used to apply the `AuthorEntityBinder` to par
9495

9596
[!code-csharp[](custom-model-binding/samples/3.x/CustomModelBindingSample/Controllers/BoundAuthorsController.cs?name=snippet_GetById&highlight=2)]
9697

97-
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.
9899

99100
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.
100101

@@ -104,7 +105,7 @@ Instead of applying an attribute, you can implement `IModelBinderProvider`. This
104105

105106
[!code-csharp[](custom-model-binding/samples/3.x/CustomModelBindingSample/Binders/AuthorEntityBinderProvider.cs?highlight=17-20)]
106107

107-
> Note:
108+
> [!NOTE]
108109
> 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.
109110
110111
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:
200201

201202
In the preceding code, the `ModelBinder` attribute specifies the type of `IModelBinder` that should be used to bind `Author` action parameters.
202203

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:
204205

205206
[!code-csharp[](custom-model-binding/samples/2.x/CustomModelBindingSample/Binders/AuthorEntityBinder.cs?name=demo)]
206207

207208
> [!NOTE]
208-
> 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.
209210
210211
The following code shows how to use the `AuthorEntityBinder` in an action method:
211212

@@ -215,7 +216,7 @@ The `ModelBinder` attribute can be used to apply the `AuthorEntityBinder` to par
215216

216217
[!code-csharp[](custom-model-binding/samples/2.x/CustomModelBindingSample/Controllers/BoundAuthorsController.cs?name=demo1&highlight=2)]
217218

218-
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.
219220

220221
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.
221222

@@ -225,7 +226,7 @@ Instead of applying an attribute, you can implement `IModelBinderProvider`. This
225226

226227
[!code-csharp[](custom-model-binding/samples/2.x/CustomModelBindingSample/Binders/AuthorEntityBinderProvider.cs?highlight=17-20)]
227228

228-
> Note:
229+
> [!NOTE]
229230
> 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.
230231
231232
To use a custom model binder provider, add it in `ConfigureServices`:

0 commit comments

Comments
 (0)