ASP.NET Core Web API’da Swagger ile Dökümantasyon Oluşturma

Okuma Süresi: 4 dakika

ASP.NET Core ile geliştirmiş olduğumuz Web API’ları kullanarak uygulama geliştirecek olan kişiler için dökümantasyon oldukça önemlidir. API’ın hangi endpointlere sahip olduğu, hangi HTTP metoduyla iletişim kuracağı, endpoint’in almış olduğu parametreler ve body içeriği, API’dan dönecek olan cevabın içeriğinin nasıl olduğu gibi bilgileri vermek uygulama geliştiricilerin işlerini oldukça kolaylaştıracaktır.

ASP.NET Core’da geliştirilmiş olan API’ların dökümantasyonu için kullanabileceğimiz araçlardan birisi Swagger‘dır. Swagger, açık kaynak kodlu bir araçtır. ASP.NET Core özelinde bir araç değildir. 20’nin üzerinde programlama dili veya kütüphane için desteği bulunmaktadır. Swagger’ın kendine has bir JSON dosyası oluşturmaktadır. Oluşturulan bu JSON dosyasından ister Swagger UI‘ı kullanarak isterseniz de kendinizin geliştireceği bir tema ile dökümantasyonunuzu oluşturabilirsiniz.

O zaman örnek uygulamamızı geliştirmeye başlayalım. Öncelikle aşağıdaki terminal komutunu kullanarak yeni bir ASP.NET Core Web API projesi oluşturalım ve kullanmış olduğumuz IDE veya metin editörüyle projemizi açalım.

dotnet new webapi -o aspnetcore-swagger-sample -n AspNetCore.Swagger.Sample

Projemizi oluşturduktan sonra sıra geldi Swagger dosyamızı oluşturacak olan paketi projemize referans olarak eklemeye. Bu işlem için Swashbuckle.AspNetCore paketini kullanacağız. Aşağıdaki komut ile ilgili paketi projemize referans olarak ekleyelim.

dotnet add package Swashbuckle.AspNetCore

İlgili paketimiz ekledikten sonra sırada Swagger ayarlarının yapılması var. Swagger ayalarını yapmak için Startup.cs dosyamızın içeriğini aşağıdaki gibi değiştirelim.

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Swashbuckle.AspNetCore.Swagger;

namespace AspNetCore.Swagger.Sample
{
	public class Startup
	{
		public Startup(IConfiguration configuration)
		{
			Configuration = configuration;
		}

		public IConfiguration Configuration { get; }

		// This method gets called by the runtime. Use this method to add services to the container.
		public void ConfigureServices(IServiceCollection services)
		{
			services.AddMvc();

			services.AddSwaggerGen(c =>
			{
				c.SwaggerDoc("v1", new Info { Title = "Sample Web API", Version = "v1" });
			});
		}

		// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
		public void Configure(IApplicationBuilder app, IHostingEnvironment env)
		{
			if (env.IsDevelopment())
			{
				app.UseDeveloperExceptionPage();
			}

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

			app.UseMvc();
		}
	}
}

AddSwaggerGen metodu ile Swagger JSON dosyamızın oluşturulmasını sağladık. Parametre olarak aldığı Info tipinden bir nesne ile API’ımıza ait çeşitli bilgileri tanımlıyoruz. API’ın adı, sürümü, geliştirici bilgileri v.b. gibi bilgileri burada tanımlıyoruz.

UseSwaggerUI metodu ile Swagger UI’ın dosyalarının oluşturulmasını ve tarayıcı üzerinden erişebilmek için ilgili route tanımlamalarının yapılması sağlanmaktadır.

Şimdi Swagger’ın çalışıp çalışmadığını test edebilmek için projemizi çalıştıralım ve tarayıcıdan http://localhost:5000/swagger adresine girelim. Eğer herhangi bir sorun yoksa aşağıdaki gibi bir ekranla karşılaşacağız.

Values endpoint’ine ait dökümantasyon oluştu.

Dökümantasyonun bir kısmı başarıyla oluştu ancak hala yetersiz bilgiler mevcut. Örneğin endpoint’ler ne işe yarıyor ve HTTP durum kodlarına göre endpoint’den gelecek olan cevabın modeli nedir gibi soruların cevabı bulunmamaktadır.

Şimdi endpoint açıklamalarının gözükmesini sağlayalım. Bu işlem için ValuesController.cs dosyamızı açalım ve aşağıdaki değişiklikleri yapalım.

using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;

namespace AspNetCore.Swagger.Sample.Controllers
{
	[Route("api/[controller]")]
	public class ValuesController : Controller
	{
		/// <summary>
		/// Get all values
		/// </summary>
		[HttpGet]
		public IEnumerable<string> Get()
		{
			return new string[] { "value1", "value2" };
		}

		/// <summary>
		/// Get value by id
		/// </summary>
		/// <param name="id">Value id</param>
		[HttpGet("{id}")]
		public string Get(int id)
		{
			return "value";
		}

		/// <summary>
		/// Create a new value
		/// </summary>
		[HttpPost]
		public void Post([FromBody] string value)
		{
		}

		/// <summary>
		/// Update value by id
		/// </summary>
		/// <param name="id">Value id</param>
		/// <param name="value">Value informations</param>
		[HttpPut("{id}")]
		public void Put(int id, [FromBody] string value)
		{
		}

		/// <summary>
		/// Delete a value by id
		/// </summary>
		/// <param name="id">Value id</param>
		[HttpDelete("{id}")]
		public void Delete(int id)
		{
		}
	}
}

Endpoint açıklamalarını XML Documentation Comments kurallarına göre her action’ın başına ekledik. Bu sayede Swagger dosyası oluşurken ilgili açıklamaların eklenmesini sağladık. Eklemiş olduğumuz açıklamalara ait XML dosyalarının oluşabilmesi için AspNetCore.Swagger.Sample.csproj dosyasını aşağıdaki gibi düzenliyoruz.

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>netcoreapp2.0</TargetFramework>
  </PropertyGroup>

  <PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.All" AllowExplicitVersion="true" />
    <PackageReference Include="Swashbuckle.AspNetCore" Version="4.0.1" />
  </ItemGroup>

</Project>

7. ve 9. satırlar arasındaki düzenlemeleri yaparak build işlemi esnasında XML dosyasının oluşmasını sağladık.

Son aşama olarak oluşan XML dosyasının yolunu Swagger’a bildirerek açıklamaların UI’da gözükmesini sağlamak. Bu iş için Startup.cs dosyasının içeriğini aşağıdaki gibi değiştirelim.

using System;
using System.IO;
using System.Reflection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Swashbuckle.AspNetCore.Swagger;

namespace AspNetCore.Swagger.Sample
{
	public class Startup
	{
		public Startup(IConfiguration configuration)
		{
			Configuration = configuration;
		}

		public IConfiguration Configuration { get; }

		// This method gets called by the runtime. Use this method to add services to the container.
		public void ConfigureServices(IServiceCollection services)
		{
			services.AddMvc();

			services.AddSwaggerGen(c =>
			{
				c.SwaggerDoc("v1", new Info { Title = "Sample Web API", Version = "v1" });

				var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
				var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
				c.IncludeXmlComments(xmlPath);
			});
		}

		// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
		public void Configure(IApplicationBuilder app, IHostingEnvironment env)
		{
			if (env.IsDevelopment())
			{
				app.UseDeveloperExceptionPage();
			}

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

			app.UseMvc();
		}
	}
}

30. ve 32. satırlar arasında eklediğimiz kod sayesinde Swagger’ın JSON dosyası oluşurken XML dosyasının içeriğinin de yüklenmesini sağladık.

Bu işlemleri yaptıktan sonra projemizi çalıştıralım. Herhangi bir sorun yoksa aşağıdakine benzer bir ekranla karşılaşacağız.

Swagger UI’a erişirken http://localhost:5000/swagger/ adresi üzerinden ulaşıyoruz. Bu adresteki swagger ifadesini help olarak değiştirmek istediğimizde SwaggerUIOptions.RoutePrefix özelliğinin değerini değiştirmemiz yeterlidir. Biz http://localhost:5000/help/ adresi üzerinden ulaşmak istediğimizi varsayalım. Bunun için Startup.cs dosyasını aşağıdaki şekilde düzenleyelim.

using System;
using System.IO;
using System.Reflection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Swashbuckle.AspNetCore.Swagger;

namespace AspNetCore.Swagger.Sample
{
	public class Startup
	{
		public Startup(IConfiguration configuration)
		{
			Configuration = configuration;
		}

		public IConfiguration Configuration { get; }

		// This method gets called by the runtime. Use this method to add services to the container.
		public void ConfigureServices(IServiceCollection services)
		{
			services.AddMvc();

			services.AddSwaggerGen(c =>
			{
				c.SwaggerDoc("v1", new Info { Title = "Sample Web API", Version = "v1" });

				var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
				var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
				c.IncludeXmlComments(xmlPath);
			});
		}

		// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
		public void Configure(IApplicationBuilder app, IHostingEnvironment env)
		{
			if (env.IsDevelopment())
			{
				app.UseDeveloperExceptionPage();
			}

			app.UseSwagger();
			app.UseSwaggerUI(c =>
			{
				c.SwaggerEndpoint("/swagger/v1/swagger.json", "Sample Web API v1");
				c.RoutePrefix = "help";
			});

			app.UseMvc();
		}
	}
}

48. satırdaki değişikliği yapıp uygulamamızı çalıştırdığımız zaman Swagger UI’a artık http://localhost:5000/help/ adresinden erişebiliriz.

Örnek projeye https://github.com/mennan/aspnetcore-swagger-sample adresinden ulaşabilirsiniz.

ASP.NET Core’da ile Farklı Configuration Provider Geliştirme

Okuma Süresi: 3 dakika

ASP.NET Core ile oluşturmuş olduğunuz bir uygulamaya ait belli başlı ayarları olabilir. ASP.NET Core’da varsayılan olarak File Configuration Provider (INI, JSON ve XML dosyaları) kullanılmaktadır. Ancak bazı durumlarda ayarlarımızı farklı ortamlarda saklayıp yüklememiz gerekebilir. Örneğin Redis’te, Vault’ta veya environment variable’da (ortam değişkenleri) saklayabiliriz. Bu gibi durumlarda kendi configuration provider’ımızı geliştirmemiz gerekmektedir.

Bugün yapacağımız örnekte uygulama ayarlarını Redis’te tutup uygulama başlatılırken ayarların okunmasını sağlayacağız.

Öncelikle aşağıdaki komutla yeni bir ASP.NET Core uygulaması oluşturup metin editörümüzle veya IDE’mizle açalım.

dotnet new mvc -n AspNetCoreCustomConfigSample -o aspnetcore-custom-config-sample

Uygulamamız üzerinden Redis’e bağlanabilmek için StackExchange.Redis paketini kullanacağız. Aşağıdaki komutu yazarak ilgili paketi projemize referans olarak ekliyoruz.

dotnet add package StackExchange.Redis

Ayarlarımızı Redis üzerinde Settings ismindeki anahtarda tutacağız. İçeriği aşağıdaki gibi JSON yapıda olacaktır.

{
  "AppName": "Redis Configuration Sample",
  "AppVersion": "1.0.0"
}

Geliştireceğimiz sınıflar aşağıdaki gibi olacaktır:

  • Configuration Provider
  • Configuration Source
  • Extension Methods

İlk önce Configuration Provider sınıfımızı geliştirmeye başlayacağız. RedisConfigurationProvider isminde bir sınıf oluşturalım ve içeriğini aşağıdaki gibi değiştirelim.

using aspnetcore_custom_config_sample.Model;
using Microsoft.Extensions.Configuration;
using Newtonsoft.Json;
using StackExchange.Redis;

namespace aspnetcore_custom_config_sample.Configuration
{
	public class RedisConfigurationProvider : ConfigurationProvider
	{
		private readonly string _redisHost;

		public RedisConfigurationProvider(string redisHost)
		{
			_redisHost = redisHost;
		}

		public override void Load()
		{
			var options = ConfigurationOptions.Parse(_redisHost);
			var connectionMultiplexer = ConnectionMultiplexer.Connect(options);
			var redisSettings = connectionMultiplexer.GetDatabase().StringGet("Settings");
			var settings = JsonConvert.DeserializeObject<AppSettings>(redisSettings);

			Data.Add("AppName", settings.AppName);
			Data.Add("AppVersion", settings.AppVersion);
		}
	}
}

Yazmış olduğumuz Configuration Provider sınıfında base sınıftaki Load metodunu ezmekteyiz. Load metodunun içerisinde Redis’e bağlanarak ilgili ayarları okuyoruz ve yine base sınıftan gelen Data ismindeki Dictionary‘nin içeriğini dolduruyoruz.

İkinci adımda ise Configuration Source sınıfımızı geliştireceğiz. RedisConfigurationSource isminde bir sınıf ekliyoruz ve içeriğini aşağıdaki şekilde değiştiriyoruz.

using Microsoft.Extensions.Configuration;

namespace aspnetcore_custom_config_sample.Configuration
{
	public class RedisConfigurationSource : IConfigurationSource
	{
		private readonly string _redisHost;

		public RedisConfigurationSource(string redisHost)
		{
			_redisHost = redisHost;
		}

		public IConfigurationProvider Build(IConfigurationBuilder builder)
		{
			return new RedisConfigurationProvider(_redisHost);
		}
	}
}

Configuration Source sınıfımız IConfigurationSource sınıfından türemektedir. IConfigurationSource interface’i Build isminde bir metot bulundurmaktadır. Bu sınıf bir configuration provider’ı temsil etmek için bulunmaktadır. Bizim Configuration Source sınıfımız ise RedisConfigurationProvider’ı temsil etmektedir. Constructor metottan parametre olarak Redis sunucumuzun adresini almaktadır.

Şimdi sıra extension metotları geliştirmeye geldi. ConfigurationExtensions isminde bir sınıf oluşturarak içeriğini aşağıdaki şekilde değiştirelim.

using Microsoft.Extensions.Configuration;

namespace aspnetcore_custom_config_sample.Configuration
{
	public static class ConfigurationExtensions
	{
		public static IConfigurationBuilder AddRedisConfiguration(this IConfigurationBuilder configuration, string redisHost)
		{
			configuration.Add(new RedisConfigurationSource(redisHost));
			return configuration;
		}
	}
}

Bu sınıfımızın amacı ise IConfigurationBuilder tipindeki bir nesne örneğine Configuration Source sınıfımızın nesne örneğini eklemektedir. Bu sayede ASP.NET Core uygulamamız artık Redis’ten uygulama ayarlarımızı okuyabilecek hale gelecektir.

Son adım olarak extension metodumuzu kullanmak kaldı. Bunun için Program.cs dosyamızı aşağıdaki şekilde değiştiriyoruz.

using aspnetcore_custom_config_sample.Configuration;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;

namespace AspNetCoreCustomConfigSample
{
	public class Program
	{
		public static void Main(string[] args)
		{
			BuildWebHost(args).Run();
		}

		public static IWebHost BuildWebHost(string[] args) =>
			WebHost.CreateDefaultBuilder(args)
				.ConfigureAppConfiguration(AddRedisConfiguration)
				.UseUrls("http://localhost:5000")
				.UseStartup<Startup>()
				.Build();

		private static void AddRedisConfiguration(WebHostBuilderContext context, IConfigurationBuilder builder)
		{
			var configuration = builder.Build();
			builder.AddRedisConfiguration("localhost");
		}
	}
}

ConfigureAppConfiguration metodu parametre olarak bir delegate almaktadır. Delegate ettiğimiz metot ile AddRedisConfiguration extension metodunu kullanarak ASP.NET Core’un uygulamamız yüklenirken ayarlarımızı Redis’ten okumasını sağladık.

Şimdi ayarlarımızı okumaya geldi. Ayarlarımızı örnek olması açısından HomeController üzerinden okuyacağız. HomeController’ın içeriğini aşağıdaki şekilde değiştiriyoruz.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using AspNetCoreCustomConfigSample.Models;
using aspnetcore_custom_config_sample.Model;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.Configuration;

namespace AspNetCoreCustomConfigSample.Controllers
{
	public class HomeController : Controller
	{
		private readonly IConfiguration _appSettings;

		public HomeController(IConfiguration config)
		{
			_appSettings = config;
		}

		public IActionResult Index()
		{
			ViewBag.AppName = _appSettings.GetSection("AppName").Value;
			ViewBag.AppVersion = _appSettings.GetSection("AppVersion").Value;

			return View();
		}
	}
}

Dependency Injection yardımıyla IConfiguration tipinde bir nesne örneği alıyoruz. Index action’ında ise AppName ve AppVersion değerlerini okuyarak ViewBag‘lere atıyoruz. AppName ve AppVersion isimleri ise Configuration Provider sınıfımızda Data Dictionary‘sine eklemiş olduğumuz anahtar alanlardır.

Son olarak Home/Index.cshtml dosyamızı aşağıdaki şekilde düzenliyoruz.

@{
    ViewData["Title"] = "Home Page";
}

<h1>@ViewBag.AppName</h1>
<h2>@ViewBag.AppVersion</h2>

Uygulamızı tarayıcımızla ile açtığımızda aşağıdaki ekran görüntüsünü görmekteyiz.

Örnek proje dosyalarına https://github.com/mennan/aspnetcore-custom-config-sample adresinden ulaşabilirsiniz.

.Net Core’da HttpClient ile Proxy Kullanımı

Okuma Süresi: 2 dakika

.Net Core ile geliştirdiğimiz uygulamalarda HttpClient sınıfını kullanarak uç noktalara istek atmamız gerekebilir. Örnek olarak kurumsal firmalarda çalışacak olan uygulamanız internet ortamındaki bir adrese istek göndermek isteyebilir. Ancak uygulamanızın çalışmış olduğu sunucunun internet erişimi kısıtlandığından dolayı ilgili adrese erişemeyebilirsiniz veya HttpClient sınıfı kullanarak göndermiş olduğunuz isteği ve gelen cevabı Charles Web Debugging Proxy gibi uygulamalar ile araya girerek takip etmek isteyebilirsiniz. Bu işlemleri yapabilmeniz için HttpClient ile birlikte proxy kullanmanız gerekmektedir.

HttpClient ile atılan isteklerde proxy tanımı yapabilmek için HttpClientHandler ve WebProxy sınıflarına ihtiyacımız vardır.

Örnek uygulama olarak .Net Core’da bir console projesi oluşturacağız. Aşağıda bash komutları ile projemizi oluşturalım.

dotnet new console -n NetCoreHttpClientProxy
cd NetCoreHttpClientProxy

Projemizi kullanmış olduğumuz metin editörü veya IDE ile açarak aşağıdaki şekilde kodlarımızı yazalım.

using System;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;

namespace NetCoreHttpClientProxy
{
	class Program
	{
		static async Task Main(string[] args)
		{
			const string ProxyUrl = "http://localhost:5001";
			const string ProxyUsername = "";
			const string ProxyPassword = "";
			const string RequestUrl = "https://google.com";

			var proxy = new WebProxy
			{
				Address = new Uri(ProxyUrl),
				Credentials = new NetworkCredential(ProxyUsername, ProxyPassword)
			};

			var httpClientHandler = new HttpClientHandler
			{
				Proxy = proxy,
				UseProxy = true
			};

			using (var client = new HttpClient(httpClientHandler))
			{
				var response = await client.GetAsync(RequestUrl);

				if (response.IsSuccessStatusCode)
				{
					var responseString = await response.Content.ReadAsStringAsync();
					Console.WriteLine(responseString);
				}
			}
		}
	}
}

Yapmış olduğumuz işlemleri açıklamak gerekirse https://google.com adresine http://localhost:5001 proxy adresini kullanarak istek göndermekteyiz.

Öncelikle WebProxy sınıfını kullanarak proxy adresini ve proxy’ye ait kullanıcı adı ve şifre tanımlamalarını yapıyoruz. Eğer proxy’ye ait herhangi bir kullanıcı adı ve şifre bilgisi bulunmuyorsa Credentials özelliğine değer vermenize gerek yoktur.

Sonrasında ise oluşturmuş olduğumuz WebProxy nesnesini HttpClientHandler tipindeki bir nesnenin Proxy özelliğine atıyoruz ve ilgili nesne örneğinin UseProxy özelliğini true olarak ayarlıyoruz.

En son işlem olarak ise HttpClient tipinin nesne örneğini oluştururken yapıcı metoda (constructor) HttpClientHandler tipindeki nesne örneğini vermek. Bu aşamadan sonra HttpClient tipindeki nesne örneğinden gönderilecek işlem proxy üzerinden geçerek atılacaktır.

Örnek kodlara https://github.com/mennan/netcore-httpclient-proxy adresinden ulaşabilirsiniz.

ASP.NET Core Uygulamalarında Remote IP Adresi Problemi

Okuma Süresi: 1 dakikaASP.NET Core ile geliştirilmiş bir web uygulamasının load balancer arkasında çalışabilmesi için UseForwardedHeaders middleware’ının kullanılması gerekmektedir. Bu middleware load balancer’ın yönlendirdiği X-Forwarded-Proto ve X-Forwarded-For http headerlarından gelen değerin uygulamamız tarafından erişilebilmesini sağlar. Örnek kullanımı aşağıdaki gibidir.

var forwardingOptions = new ForwardedHeadersOptions()
{
 ForwardedHeaders = ForwardedHeaders.XForwardedAll
};

app.UseForwardedHeaders(forwardingOptions);

Bu middleware sayesinde kullanıcının IP adresini elde edebilirsiniz. Ancak Google Cloud gibi ortamlarda çalışan bir uygulamanız varsa IP adresi talebi yaptığınız zaman load balancer’ın IP adresini size verecektir. Bu sorunun sebebi ForwardedHeadersOptions sınıfının KnownProxies özellik değerinin IPAddress.Loopback olmasından dolayı kaynaklanmaktadır. Sorunun çözümü KnownProxies özelliğine ya load balancer’ın ve uygulamanın çalıştığı makinenin IP adresini vermek ya da bu özelliğin değerini sıfırlamak gerekir.

var forwardingOptions = new ForwardedHeadersOptions()
{
ForwardedHeaders = ForwardedHeaders.XForwardedAll
};
forwardingOptions.KnownNetworks.Clear();
forwardingOptions.KnownProxies.Clear();

app.UseForwardedHeaders(forwardingOptions);

Kaynak: https://stackoverflow.com/questions/43749236/net-core-x-forwarded-proto-not-working