ASP.NET Core Web API Versioning

Mar 28, 2017 by reyza    5 Comments    Posted under: I am Software Developer

ASP.NET Web API merupakan implementasi RESTful API service, adalah application program interface (API) yang menggunakan HTTP request untuk melakukan GET, PUT, POST dan DELETE data.  RESTful API Service ini biasanya diakses oleh aplikasi client seperti aplikasi desktop  atau aplikasi web, tapi umumnya lebih sering digunakan oleh aplikasi mobile.  Dalam dunia nyata, contoh implementasi seperti yang dilakukan oleh Twitter atau Facebook.  Keduanya memiliki Restful API service untuk dapat diakses oleh aplikasi client.  Selain digunakan oleh aplikasi mobile Twitter dan Facebook yang dibangun oleh Twitter dan Facebook sendiri tetapi juga dapat digunakan oleh kita atau software developer lain yang ingin mengambil data dari Twitter dan Facebook, atau jika ingin menggunakan proses otentikasi milik Twitter dan Facebook.

Nah seperti halnya software pada umumnya, fungsi-fungsi pada Restful API service juga dapat mengalami perbaikan, penambahan atau mungkin ada fungsi yang dihilangkan.  Jika RESTful API service sekelas Twitter dan Facebook begitu saja mengganti dan menghapus fungsi yang ada maka dampaknya mungkin akan membuat aplikasi client yang kita dan software developer buat akan mengalami kegagalan. Oleh karena itu, Twitter dan Facebook mengelola perubahan ini dengan melakukan versioning. Teknik versioning ini memungkinkan kita untuk tetap dapat mengakses dan menggunakan fungsi-fungsi lama dari Restful API service, dan juga dapat mengakses dan menggunakan fungsi-fungsi baru.  Artinya kedua versi dari layanan bisa diakses. Hal ini memungkinkan kita dapat memiliki waktu untuk mengupgrade aplikasi yang kita bangun untuk menggunakan fungsi-fungsi Restful API service yang baru.

Sekarang implementasi versioning pada ASP.NET Web API dapat dilakukan dengan mudah dengan menggunakan library “ASP.NET API Versioning”.  Pada posting ini akan diberikan contoh implementasi versioning pada ASP.NET Core Web API.

Dengan asumsi telah dimiliki project ASP.NET Core Web API, langkah pertama yang perlu dilakukan adalah menambahkan library “ASP.NET API Versioning” ke dalam project. Caranya adalah dengan memodifikasi file *.csproj menjadi seperti contoh berikut.  Penambahkan library dapat dilihat pada baris 18.

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

   2:

   3:   <PropertyGroup>

   4:     <TargetFramework>netcoreapp1.1</TargetFramework>

   5:   </PropertyGroup>

   6:

   7:

   8:   <ItemGroup>

   9:     <PackageReference Include="Microsoft.AspNetCore" Version="1.1.1" />

  10:     <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="1.1.2" />

  11:     <PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="1.1.1" />

  12:     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="1.1.1" />

  13:     <PackageReference Include="Microsoft.VisualStudio.Web.BrowserLink" Version="1.1.0" />

  14:     <PackageReference Include="MySql.Data.Core" Version="7.0.4-IR-191" />

  15:     <PackageReference Include="Microsoft.EntityFrameworkCore" Version="1.1.1" />

  16:     <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="1.1.0" />

  17:     <PackageReference Include="MySql.Data.EntityFrameworkCore" Version="7.0.4-IR-191" />

  18:     <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" Version="1.0.3" />

  19:   </ItemGroup>

  20:

  21:

  22: </Project>

Kemudian perlu ditambahkan method services.AddApiVersioning(); di dalam method ConfigureServices pada file Startup.cs, seperti yang dapat dilihat pada baris no. 5.

   1: public void ConfigureServices(IServiceCollection services)

   2: {

   3:     // Add framework services.

   4:     services.AddMvc();

   5:     services.AddApiVersioning();

   6:     . . .

   7: }

{Versi 1.0}

Berikut ini adalah contoh class Web API Controller.

   1: using System.Collections.Generic;

   2: using Microsoft.AspNetCore.Mvc;

   3:

   4: [ApiVersion( "1.0" )]

   5: [Route( "api/v{version:apiVersion}/[controller]" )]

   6: public class HelloWorldController : Controller {

   7:     [HttpGet]

   8:     public string Get() {

   9:         return "Hello world ver 1.0 !";

  10:     }

  11: }

Pada class di atas dapat dilihat untuk menentukan versi API dengan cara memberikan atribut pada class HelloWorldController seperti yang dilihat pada baris ke-4.  Sedangkan format URL untuk mengakses class web API ini adalah baris ke-5.  Artinya class ini dapat diakses dengan URL berikut.

http://localhost:5000/api/v1.0/helloworld

Pada baris ke-5, parameter [controller] ditulis dengan huruf kecil, oleh karena itu seluruh nama class controller di atas juga ditulis dengan huruf kecil seperti pada contoh URL di atas.  Parameter [controller] akan menyesuaikan dengan nama class yang digunakan, karena nama class adalah HelloWorldController maka pada URL class ini dipanggil dengan cara “helloworld”.  Jika nama class adalah HelloWebAPI maka pada URL class ditulis “hellowebapi”.

{Ver 2.0 & 3.0}

Sebuah class web API controller dapat digunakan untuk menangani 2 versi sekaligus. Berikut adalah contoh implementasinya.

   1: using System.Collections.Generic;

   2: using Microsoft.AspNetCore.Mvc;

   3:

   4: [ApiVersion( "2.0" )]

   5: [ApiVersion( "3.0" )]

   6: [Route( "api/v{version:apiVersion}/helloworld" )]

   7: public class HelloWorld2Controller : Controller {

   8:     [HttpGet]

   9:     public string Get() {

  10:         return "Hello world ver 2.0 !";

  11:     }

  12:

  13:     [HttpGet, MapToApiVersion( "3.0" )]

  14:     public string GetV3() {

  15:         return "Hello world ver 3.0 !";

  16:     }

  17: }

Pada baris ke-4 dan ke-5 adalah atribut pada class untuk memberikan atribut versi.  Secara default versi class ini adalah baris ke-4  yaitu versi 2.0, karena versi ini dideklarasikan pertama.  Kemudian dapat dilihat nama class controller di atas adalah HelloWorld2Controller, jadi semestinya secara default class ini diakses dengan cara menulis “helloworld2”.  Tetapi pada baris ke-6 dapat dilihat format untuk akses class ini, pada baris ini tidak digunakan parameter [controller], tetapi secara manual digunakan nilai “helloworld”.  Sehingga class ini dapat diakses dengan URL berikut.

http://localhost:5000/api/v2.0/helloworld

hasilnya akan dikeluarkan output berikut ini.

Pada class ini dapat dilihat terdapat 2 method yang menggunakan HTTP request GET yaitu Get() dan GetV3().  Pada contoh di atas method GetV3() dimapping sebagai method versi 3.0 dengan cara memberikan atribut pada method ini seperti yang dilihat pada baris ke-13. Untuk mengakses method ini dapat dilakukan dengan cara menggunakan URL berikut ini.

http://localhost:5000/api/v3.0/helloworld

Dengan penjelasan di atas dapat dilihat pengelolaan versi web API dapat dilakukan dengan mudah.

Berikut adalah source code dari contoh di atas: https://github.com/rezafaisal/ASPNETCoreMySQL/tree/master/EFCoreWebAPI.

Semoga bermanfaat

Got anything to say? Go ahead and leave a comment!