Missing Swagger code

[mikefizzled]

Description

In the 'Register the database context' section of the tutorial, the complete code sample is missing the Swagger configuration line that was previously added in the 'Configure Swagger middleware' section.

The user is instructed to either update their code with the highlighted changes or copy the entire code box. If they copy the code box, the Swagger UI is omitted. Later in the tutorial, the user is asked to navigate to the Swagger URL, which won’t work if they used the copied code.

It may seem obvious, but if the user is following the tutorial sequentially, the omission feels accidental. The complete code sample is already available and can be easily reinserted.

Page URL

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

Content source URL

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

Document ID

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

Platform Id

5e962f0c-0c64-0e03-aba5-9c8b1bdd9b95

Article author

@wadepickett

Metadata

• ID: 583ae3e7-5915-f22b-e54c-6c100cf2a7da
• PlatformId: 5e962f0c-0c64-0e03-aba5-9c8b1bdd9b95
• Service: aspnet-core
• Sub-service: tutorials

Related Issues

---

Associated WorkItem - 489792

[wadepickett]

Quick Triage Assessment and Plan of Action

Issue Summary

This is a valid issue. The user has correctly identified that in the 'Register the database context' section of the first-web-api tutorial, the complete code sample is missing the Swagger configuration line that was previously added in the 'Configure Swagger middleware' section.

Issue Details

In the "Register the database context" section (around line 323 of the tutorial):

The "Register the database context" section needs be part of the previous Visual Studio Code tab section that follows:
"Add a database context
The database context is the main class that coordinates Entity Framework functionality for a data model. This class is created by deriving from the Microsoft.EntityFrameworkCore.DbContext class."

"Register the database context" section needs to have one copy for the Visual Studio tab, and another copy for the Visual Studio Code tab. Then the copy of the Visual Studio Code tab needs to point to the swagger version of the app sample. So instead of the code snippet in that case linking here:

:::code language="csharp" source="~/tutorials/first-web-api/samples/9.0/TodoApi/Program.cs" highlight="1-2,8-9":::

It should link here:

:::code language="csharp" source="~/tutorials/first-web-api/samples/9.0/TodoApi_SwaggerVersion/Program.cs" highlight="1-2,8-9":::