.NET Core Web API için Swagger Kullanımı

Adı : .NET Core Web API için Swagger Kullanımı

Swagger, API belgeleme ve test aracı olarak kullanılabilen açık kaynaklı bir çerçevedir. .NET Core Web API projelerinde Swagger'ı kullanarak geliştirilen API'lerin belgelendirilmesi ve test edilmesi kolaylaşmaktadır. Bu yazıda, .NET Core Web API için Swagger kullanımı hakkında detaylı bilgileri ve örnekleri bulabilirsiniz.

Swagger Nedir?

Swagger, açık kaynaklı bir API çerçevesidir ve API'lerin otomatik olarak belgelendirilmesine, test edilmesine ve tüketilmesine olanak sağlar. Swagger, API tanımlama dilini (Swagger Specification) kullanarak API'leri belgeleyen ve API otomatik dökümantasyonunu sağlayan bir araçtır.

Swagger, bir API'yi tarayarak metotlarını, parametrelerini, veri türlerini ve diğer ayrıntılarını tanır. Bu sayede API otomatik olarak belgelendirilir ve test edilebilir. Kullanıcılar, Swagger UI aracılığıyla API'ye ait metotları test edebilir ve hata ayıklama yapabilir.

Swagger’ın kullanımının avantajları şunlardır:

- API'lerin otomatik olarak belgelendirilmesini sağlar.
- API'lerin test edilmesini kolaylaştırır.
- API'lerin tüketilmesini kolaylaştırır.
- Geliştirme sürecini hızlandırır ve API'lerin daha kolay anlaşılabilmesini sağlar.

Swagger Nasıl Kullanılır?

.NET Core Web API projelerinde Swagger'ı kullanmak için aşağıdaki adımları izlemeliyiz:

Adım 1: Swagger NuGet Paketini Yükleme

Swagger'ı kullanmak için Swagger NuGet paketini projemize yüklememiz gerekmektedir. Proje dosyasına (csproj) aşağıdaki paketi ekleyebiliriz:

```

```

Daha sonra Visual Studio Paket Yöneticisi veya .NET CLI kullanarak paketi yükleyebiliriz.

Adım 2: Startup Sınıfına Swagger'ı Eklemek

`ConfigureServices` metodunda Swagger'ı eklemek için aşağıdaki kodu eklememiz gerekmektedir:

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

Adım 3: Swagger UI'ı Projeye Ekleme

`Configure` metodunda Swagger UI'ı projeye eklemek için aşağıdaki kodu ekleyebiliriz:

```csharp
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint(\"/swagger/v1/swagger.json\", \"APIName\");
});
```

Bu adımları tamamladıktan sonra projeyi başlattığımızda, Swagger UI'ın kullanılabilir olacağını göreceksiniz. Tarayıcınızda \"https://localhost:{port}/swagger\" adresine giderek Swagger UI'ı kullanabilirsiniz. API'ye ait belgelendirmeleri ve test arayüzünü buradan görüntüleyebilirsiniz.

Örnek Kullanım: Öğrenci API'si

Aşağıda bir öğrenci API'si örneği verilmektedir.

```csharp
[Route(\"api/[controller]\")]
[ApiController]
public class StudentsController : ControllerBase
{
private static List _students;

public StudentsController()
{
if (_students == null)
{
_students = new List
{
new Student { Id = 1, Name = \"John Doe\"