search

dotnet / AspNetCore.Docs

Documentation for ASP.NET Core
https://docs.microsoft.com/aspnet/core
Creative Commons Attribution 4.0 International
12.54k stars 25.31k forks source link

UUF Min Web API tutorial: Clarify scaffolded PostTodoItem to update steps #32038

Open wadepickett opened 6 months ago

wadepickett commented 6 months ago

Description

Created based on Unified Feeback backlog from 12/12/23: "In Get TodoItem? What? Any moment, do you explain how do you this works? And using this part of the code in Visual Studio doesn't work!"

Reviewing those steps, I agree we could clarify. We go right from Scaffolding a controller to updating the generated code, but we really should show the generated code first before moving on to update it and clarify up front why we are updating it. We should either show the new controller created by scaffolding, or at least give some context when updating GetTodoItem that it was generated from the scaffolding. Also, we give a step to update PostTodoItem to use the nameof operator but we don't give the context of why until 9 lines later in a list. It should be clear that the scaffolded code works, and why we are making the improvement/change with nameof.

Page URL

https://learn.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-8.0&tabs=visual-studio

Content source URL

https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/tutorials/first-web-api.md

Document ID

95f2549e-29f9-e31a-b4d0-432b971643ff

Article author

@wadepickett

This issue is also being tracked here: Devops 229581

Associated WorkItem - 251076

wadepickett commented 4 months ago

Adding to this section may also require some code example changes, showing generated code and reviewing what is happening with its parts.

wadepickett commented 3 months ago

I need to add this one to the July sprint project in github once it is available. I already set it to July in the internal tracking. I can't get to it until then.