How to use Swagger XML Comments in an ASP .NET web app?

edit

To use Swagger XML comments in an ASP .NET web app, follow these steps:

1. Install the Swashbuckle NuGet package:

• Open the NuGet Package Manager in Visual Studio by right-clicking on the project and selecting "Manage NuGet Packages..."
• Search for "Swashbuckle" and install the latest version.

1. Configure Swashbuckle:

• In the Startup.cs file, add the following code to the ConfigureServices method:

services.AddSwaggerGen(c =>
{
   c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
   var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
   var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
   c.IncludeXmlComments(xmlPath);
});

This code configures Swashbuckle to generate Swagger documentation for version 1 of the API, and includes XML comments from the current assembly.

1. Add XML comments to your code:

• Add XML comments to your controller classes, methods, and parameters using the /// syntax. Here's an example:

/// <summary>
/// Gets an item by ID.
/// </summary>
/// <param name="id">The ID of the item to retrieve.</param>
/// <returns>The requested item.</returns>
[HttpGet("{id}")]
public ActionResult<Item> GetById(int id)
{
   Item item = _context.Items.Find(id);
   if (item == null)
   {
       return NotFound();
   }
   return item;
}

1. Run your application and navigate to the Swagger UI:

• Start your application in debug mode.
• Open a web browser and navigate to http://localhost:[port]/swagger/index.h…, where [port] is the port number your application is running on.
• You should see the Swagger UI with documentation for your API, including the endpoints you defined and their XML comments.