How to Integrate ASP.NET Swagger/OpenAPI?

Developing APIs in ASP.NET projects can become challenging, especially as documentation needs increase. With Swagger/OpenAPI integration, you can automatically document, test, and easily present your API to the outside world. In this article, we will go through step by step how to integrate ASP.NET Swagger/OpenAPI, detailing its advantages and implementation stages.

What is Swagger/OpenAPI?

Swagger, nowadays referred to as OpenAPI, is a standard that facilitates the definition and documentation of RESTful APIs. Developers can easily document API endpoints, data models, and error messages. Thanks to ASP.NET Swagger/OpenAPI integration, live testing and an easy-to-understand interface become possible.

How to Integrate ASP.NET Swagger/OpenAPI?

1. Installing the Required Packages

First, you should add the Swashbuckle.AspNetCore NuGet package to your project. You can do this easily via the NuGet Package Manager or the command line:

dotnet add package Swashbuckle.AspNetCore

2. Program.cs or Startup.cs Settings

Add the following Swagger/OpenAPI integration code to your project's Program.cs or Startup.cs file. For example, with the .NET 6+ version in the Program.cs file:

var builder = WebApplication.CreateBuilder(args);

// Add Swagger services
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Enable the Swagger UI in the development environment
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();
app.MapControllers();
app.Run();

3. Accessing the Swagger UI

After running the project, you can access the interactive Swagger/OpenAPI interface at https://localhost:5001/swagger or, depending on your port, at the /swagger path.

Advantages of Swagger/OpenAPI Integration

• Provides automatic and up-to-date API documentation.
• Allows your API to be easily tested by external developers.
• Increases communication within the team and standardization in API design.

Conclusion

With ASP.NET Swagger/OpenAPI integration, it is very easy to add modern, easy-to-understand and interactive API documentation to your projects. This approach, which greatly facilitates work for both project team members and API consumers, has become an indispensable standard in today’s software development processes. With the correct integration, your API application can also reach a professional level.