Basit API Geliştirme Örneği

api

.NET platformunda bir Web API geliştirmek oldukça kolaydır. Aşağıda adımlarla basit bir ASP.NET Core Web API oluşturma sürecini açıklıyor olacağım,

1. Gerekli Ortamı Hazırlama

2. Yeni Proje Oluşturma

  1. Visual Studio’yu Açın.
  2. Yeni Proje Oluştur seçeneğini seçin.
  3. ASP.NET Core Web API şablonunu bulun ve seçin.
  4. Proje adını belirleyin (örneğin, SimpleApi) ve oluşturun.
  5. .NET 6 (veya üstü) seçeneğini seçin.

3. API Proje Yapısını Anlama

Oluşturduğunuz projede önemli klasörler ve dosyalar şunlardır:

  • Controllers: API denetleyicilerinin bulunduğu klasör.
  • Program.cs: Uygulamanın başlangıç dosyası.
  • appsettings.json: Yapılandırma ayarlarını içerir.

4. İlk Controller’ı Oluşturma

  1. Controllers klasörüne sağ tıklayın ve Add > Controller seçeneğini seçin.
  2. API Controller – Empty şablonunu seçin ve adını WeatherController olarak belirleyin.
  3. Aşağıdaki gibi bir denetleyici yazın:
using Microsoft.AspNetCore.Mvc;

namespace SimpleApi.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    public class WeatherController : ControllerBase
    {
        // Örnek GET metodu
        [HttpGet]
        public IActionResult GetWeather()
        {
            var weatherData = new List<string> { "Sunny", "Rainy", "Cloudy", "Snowy" };
            return Ok(weatherData); // 200 OK döner
        }

        // Örnek GET metodu (parametre ile)
        [HttpGet("{day}")]
        public IActionResult GetWeatherByDay(string day)
        {
            var forecast = $"Weather for {day} is Sunny.";
            return Ok(forecast);
        }
    }
}

5. Uygulamayı Çalıştırma

  1. Ctrl + F5 tuşuna basarak projeyi başlatın.
  2. Tarayıcıda https://localhost:5001/api/weather adresine gidin.
    • GetWeather metodunun döndürdüğü listeyi görmelisiniz.
  3. https://localhost:5001/api/weather/Monday adresine gidin.
    • Günlük hava durumu mesajını görmelisiniz.

6. API’yi Postman veya Tarayıcı ile Test Etme

  • Postman veya benzeri bir araç kullanarak farklı HTTP istekleri (GET, POST, PUT, DELETE) yapabilirsiniz.
  • Örneğin, yukarıdaki API’nin GET isteklerini test etmek için şu URL’leri deneyin:
    • https://localhost:5001/api/weather
    • https://localhost:5001/api/weather/Tuesday

7. Yeni Endpoint Eklemek

API’ye yeni bir özellik eklemek için yine Controller içine yeni bir HTTP metodu ekleyebilirsiniz. Örneğin, bir POST metodu:

[HttpPost]
public IActionResult AddWeather([FromBody] string newWeather)
{
    return Ok($"New weather added: {newWeather}");
}

Bu metodu test etmek için bir JSON verisiyle POST isteği yapabilirsiniz.

8. Swagger Entegrasyonu

ASP.NET Core projelerinde Swagger otomatik olarak gelir. Bu sayede API’nizi dokümante edebilirsiniz.

  1. Program.cs dosyasında şu kodları ekleyin:
var builder = WebApplication.CreateBuilder(args);

// Swagger ekleme
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Swagger kullanımı
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

app.Run();

2. Uygulamayı çalıştırın ve tarayıcıda https://localhost:5001/swagger adresine gidin. Burada API’nizin otomatik dokümantasyonunu görebilirsiniz.

Bu adımları takip ederek, basit bir ASP.NET Core Web API oluşturabilirsiniz. API’nizi geliştirdikçe:

  • Veritabanı bağlantısı ekleyebilir,
  • Yetkilendirme mekanizmalarını entegre edebilir,
  • Daha karmaşık iş mantıkları oluşturabilirsiniz.

Write a Reply

English Translate »