Swagger/OpenAPI — CompileDaily Study

Penjelasan

Swagger (implementasi spesifikasi OpenAPI) men-generate dokumentasi API SECARA OTOMATIS dari Controller dan atribut yang sudah ada — tidak perlu menulis dokumentasi terpisah manual. Template dotnet new webapi modern sudah menyertakannya sejak awal, diakses lewat endpoint /swagger, menyediakan UI interaktif untuk mencoba tiap endpoint langsung dari browser.

Contoh Konsep

// Program.cs
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(); // akses lewat /swagger
}

// Menambah deskripsi ke endpoint (opsional, memperkaya dokumentasi):
// [HttpGet]
// [ProducesResponseType(typeof(List<Produk>), 200)]
// public IActionResult FindAll() => Ok(...);

Praktikum

Tulis (sebagai catatan) langkah-langkah mengaktifkan Swagger di project ASP.NET Core baru: apa yang perlu ditambahkan di Program.cs, dan URL default untuk mengaksesnya setelah aplikasi berjalan.

Editor Latihan

Ketik/edit bebas di sini untuk latihan — kode ini tidak dijalankan.

Tips

app.UseSwaggerUI() BIASANYA dibungkus kondisi if (app.Environment.IsDevelopment()) supaya dokumentasi interaktif ini TIDAK terekspos di production — kalau memang perlu Swagger UI di production, itu keputusan sadar yang perlu dipertimbangkan risikonya, bukan default yang aman.