How to implementation swagger in .net core api

 

Swagger is an open-source tool for documenting and testing APIs. It provides a way for developers to easily visualize and interact with the API, making it easier to understand and use. In this response, I'll provide a brief overview of how to implement Swagger in a .NET Core API.

1. Install Swashbuckle.AspNetCore
To use Swagger in a .NET Core API, you need to install the Swashbuckle.AspNetCore package. You can install it using the following command in the Package Manager Console:

```
Install-Package Swashbuckle.AspNetCore
```

2. Configure Swagger in Startup.cs
After installing Swashbuckle.AspNetCore, you need to configure it in your Startup.cs file. Add the following code to the ConfigureServices method:

```
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
```

This code adds Swagger to the service collection and configures a Swagger document with the title "My API" and version "v1".

3. Enable Swagger UI
To enable Swagger UI, add the following code to the Configure method in your Startup.cs file:

```
app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
```

This code enables the Swagger UI and configures the URL for the Swagger document that was created in step 2.

4. Add XML documentation comments
Swagger uses XML documentation comments to provide additional information about your API endpoints. To add XML documentation comments, you need to enable XML documentation in your project and add comments to your endpoints. To enable XML documentation, add the following code to your .csproj file:

```
<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
```

This code generates an XML documentation file for your project. To add comments to your endpoints, add XML comments above your endpoint methods:

```

/// <summary>

/// This is a summary of my endpoint.

/// </summary>

/// <param name="id">The ID of the item.</param>

/// <returns>The item with the specified ID.</returns>

[HttpGet("{id}")]

public ActionResult<Item> Get(int id)

{

    // ...

}

```

5. Test your API with Swagger UI
Once you've implemented Swagger in your API, you can test it using Swagger UI. Open a web browser and navigate to the URL for your API, followed by "/swagger/index.html". For example, if your API is hosted at "http://localhost:5000", you would navigate to "http://localhost:5000/swagger/index.html". This will open Swagger UI, where you can view your API endpoints and test them by sending requests.