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.\u00a0 RESTful API Service ini biasanya diakses oleh aplikasi client seperti aplikasi desktop\u00a0 atau aplikasi web, tapi umumnya lebih sering digunakan oleh aplikasi mobile.\u00a0 Dalam dunia nyata, contoh implementasi seperti yang dilakukan oleh Twitter atau Facebook.\u00a0 Keduanya memiliki Restful API service untuk dapat diakses oleh aplikasi client.\u00a0 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.<\/p>\n
Nah seperti halnya software pada umumnya, fungsi-fungsi pada Restful API service juga dapat mengalami perbaikan, penambahan atau mungkin ada fungsi yang dihilangkan.\u00a0 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.\u00a0 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.<\/p>\n
Sekarang implementasi versioning pada ASP.NET Web API dapat dilakukan dengan mudah dengan menggunakan library \u201cASP.NET API Versioning\u201d.\u00a0 Pada posting ini akan diberikan contoh implementasi versioning pada ASP.NET Core Web API.<\/p>\n
Dengan asumsi telah dimiliki project ASP.NET Core Web API, langkah pertama yang perlu dilakukan adalah menambahkan library \u201cASP.NET API Versioning\u201d ke dalam project. Caranya adalah dengan memodifikasi file *.csproj menjadi seperti contoh berikut.\u00a0 Penambahkan library dapat dilihat pada baris 18.<\/p>\n
1:<\/span> <<\/span>Project<\/span> Sdk<\/span>=\"Microsoft.NET.Sdk.Web\"<\/span>><\/span><\/pre>\n<\/p>\n
2:<\/span><\/pre>\n<\/p>\n
3:<\/span> <<\/span>PropertyGroup<\/span>><\/span><\/pre>\n<\/p>\n
4:<\/span> <<\/span>TargetFramework<\/span>><\/span>netcoreapp1.1<\/<\/span>TargetFramework<\/span>><\/span><\/pre>\n<\/p>\n
5:<\/span> <\/<\/span>PropertyGroup<\/span>><\/span><\/pre>\n<\/p>\n
6:<\/span><\/pre>\n<\/p>\n
7:<\/span><\/pre>\n<\/p>\n
8:<\/span> <<\/span>ItemGroup<\/span>><\/span><\/pre>\n<\/p>\n
9:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.AspNetCore\"<\/span> Version<\/span>=\"1.1.1\"<\/span> \/><\/span><\/pre>\n<\/p>\n
10:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.AspNetCore.Mvc\"<\/span> Version<\/span>=\"1.1.2\"<\/span> \/><\/span><\/pre>\n<\/p>\n
11:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.AspNetCore.StaticFiles\"<\/span> Version<\/span>=\"1.1.1\"<\/span> \/><\/span><\/pre>\n<\/p>\n
12:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.Extensions.Logging.Debug\"<\/span> Version<\/span>=\"1.1.1\"<\/span> \/><\/span><\/pre>\n<\/p>\n
13:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.VisualStudio.Web.BrowserLink\"<\/span> Version<\/span>=\"1.1.0\"<\/span> \/><\/span><\/pre>\n<\/p>\n
14:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"MySql.Data.Core\"<\/span> Version<\/span>=\"7.0.4-IR-191\"<\/span> \/><\/span><\/pre>\n<\/p>\n
15:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.EntityFrameworkCore\"<\/span> Version<\/span>=\"1.1.1\"<\/span> \/><\/span><\/pre>\n<\/p>\n
16:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.EntityFrameworkCore.Tools\"<\/span> Version<\/span>=\"1.1.0\"<\/span> \/><\/span><\/pre>\n<\/p>\n
17:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"MySql.Data.EntityFrameworkCore\"<\/span> Version<\/span>=\"7.0.4-IR-191\"<\/span> \/><\/span><\/pre>\n<\/p>\n
18:<\/span> <<\/span>PackageReference<\/span> Include<\/span>=\"Microsoft.AspNetCore.Mvc.Versioning\"<\/span> Version<\/span>=\"1.0.3\"<\/span> \/><\/span><\/pre>\n<\/p>\n
19:<\/span> <\/<\/span>ItemGroup<\/span>><\/span><\/pre>\n<\/p>\n
20:<\/span><\/pre>\n<\/p>\n
21:<\/span><\/pre>\n<\/p>\n
22:<\/span> <\/<\/span>Project<\/span>><\/span><\/pre>\n<\/p>\n<\/div>\n<\/div>\n
Kemudian perlu ditambahkan method services.AddApiVersioning(); di dalam method ConfigureServices pada file Startup.cs, seperti yang dapat dilihat pada baris no. 5.<\/p>\n
\n\n 1:<\/span> public<\/span> void<\/span> ConfigureServices(IServiceCollection services)<\/pre>\n<\/p>\n
2:<\/span> {<\/pre>\n<\/p>\n
3:<\/span> \/\/ Add framework services.<\/span><\/pre>\n<\/p>\n
4:<\/span> services.AddMvc();<\/pre>\n<\/p>\n
5:<\/span> services.AddApiVersioning();<\/pre>\n<\/p>\n
6:<\/span> . . .<\/pre>\n<\/p>\n
7:<\/span> }<\/pre>\n<\/p>\n<\/div>\n<\/div>\n
{Versi 1.0<\/em><\/strong>}<\/p>\nBerikut ini adalah contoh class Web API Controller.<\/p>\n
\n\n 1:<\/span> using<\/span> System.Collections.Generic;<\/pre>\n<\/p>\n
2:<\/span> using<\/span> Microsoft.AspNetCore.Mvc;<\/pre>\n<\/p>\n
3:<\/span><\/pre>\n<\/p>\n
4:<\/span> [ApiVersion( \"1.0\"<\/span> )]<\/pre>\n<\/p>\n
5:<\/span> [Route( \"api\/v{version:apiVersion}\/[controller]\"<\/span> )]<\/pre>\n<\/p>\n
6:<\/span> public<\/span> class<\/span> HelloWorldController : Controller {<\/pre>\n<\/p>\n
7:<\/span> [HttpGet]<\/pre>\n<\/p>\n
8:<\/span> public<\/span> string<\/span> Get() {<\/pre>\n<\/p>\n
9:<\/span> return<\/span> \"Hello world ver 1.0 !\"<\/span>;<\/pre>\n<\/p>\n
10:<\/span> }<\/pre>\n<\/p>\n
11:<\/span> }<\/pre>\n<\/p>\n<\/div>\n<\/div>\n
Pada class di atas dapat dilihat untuk menentukan versi API dengan cara memberikan atribut pada class HelloWorldController seperti yang dilihat pada baris ke-4.\u00a0 Sedangkan format URL untuk mengakses class web API ini adalah baris ke-5.\u00a0 Artinya class ini dapat diakses dengan URL berikut.<\/p>\n
\nhttp:\/\/localhost:5000\/api\/v1.0\/helloworld<\/pre>\n <\/p>\n<\/div>\n
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.\u00a0 Parameter [controller] akan menyesuaikan dengan nama class yang digunakan, karena nama class adalah HelloWorldController maka pada URL class ini dipanggil dengan cara \u201chelloworld\u201d.\u00a0 Jika nama class adalah HelloWebAPI maka pada URL class ditulis \u201chellowebapi\u201d.<\/p>\n
{Ver 2.0 & 3.0<\/em><\/strong>}<\/p>\nSebuah class web API controller dapat digunakan untuk menangani 2 versi sekaligus. Berikut adalah contoh implementasinya.<\/p>\n
\n\n 1:<\/span> using<\/span> System.Collections.Generic;<\/pre>\n<\/p>\n
2:<\/span> using<\/span> Microsoft.AspNetCore.Mvc;<\/pre>\n<\/p>\n
3:<\/span><\/pre>\n<\/p>\n
4:<\/span> [ApiVersion( \"2.0\"<\/span> )]<\/pre>\n<\/p>\n
5:<\/span> [ApiVersion( \"3.0\"<\/span> )]<\/pre>\n<\/p>\n
6:<\/span> [Route( \"api\/v{version:apiVersion}\/helloworld\"<\/span> )]<\/pre>\n<\/p>\n
7:<\/span> public<\/span> class<\/span> HelloWorld2Controller : Controller {<\/pre>\n<\/p>\n
8:<\/span> [HttpGet]<\/pre>\n<\/p>\n
9:<\/span> public<\/span> string<\/span> Get() {<\/pre>\n<\/p>\n
10:<\/span> return<\/span> \"Hello world ver 2.0 !\"<\/span>;<\/pre>\n<\/p>\n
11:<\/span> }<\/pre>\n<\/p>\n
12:<\/span><\/pre>\n<\/p>\n
13:<\/span> [HttpGet, MapToApiVersion( \"3.0\"<\/span> )]<\/pre>\n<\/p>\n
14:<\/span> public<\/span> string<\/span> GetV3() {<\/pre>\n<\/p>\n
15:<\/span> return<\/span> \"Hello world ver 3.0 !\"<\/span>;<\/pre>\n<\/p>\n
16:<\/span> }<\/pre>\n<\/p>\n