Adding Web API in ASP.NET Web Form Website
Misal saja sudah dibuat aplikasi web dengan ASP.NET Web Form dengan menggunakan template project Website. Dan tiba-tiba terdapat kebutuhan untuk membuat untuk menyediakan data yang akan dikonsumsi oleh aplikasi mobile. Maka perlu dibuat layanan berbasis http yang dapat diakses oleh aplikasi tersebut. Web Service adalah solusi yang paling gampang dan paling cepat dibuat untuk keperluan ini, tapiiiiiiiiiii …. karena yang akan mengaksesnya adalah platform Android maka hal itu tidak dilakukan. Hal ini dikarena pengalaman terdahulu dimana developer kesulitan untuk mengekstrak data dari output yang web service tersebut. Yang lain yang dapat digunakan adalah WCF Data Service, dengan ini output yang bisa didapat adalah dalam bentuk xml dengan format yang lebih baik daripada web service dan juga JSON.
Tapi karena keduanya sudah pernah dicoba, jadi dipilihlah teknologi yang lain yaitu ASP.NET Web API. Pada posting ini bukan membuat project ASP.NET Web API dari awal tetapi akan dijelaskan bagaimana menambahkan “kemampuan” ASP.NET Web API pada suatu Website yang telah berisi ASP.NET Web Form.
{Creating & Setting}
Langkah pertama yang dilakukan adalah klik kanan pada project Website yang telah ada, kemudian pilih Add > Add New Item.
Pada window Add New Item pilih Web API Controller Class (v1), disini saya memilih v1 karena untuk mengantisipasi deployment environment nanti. Kemudian berikan nama class yang diinginkan, di sini diberikan nama GeekController.cs. Nama Geek disini akan berpengaruh pada url yang akan digunakan untuk memanggil fungsi pada class ini. Selanjutkan klik tombol Add. Karena disini digunakan tipe project Website, maka class-class yang dibuat harus berada pada folder App_Code.
Klik tombol Yes tentunya
Nah berikut ini adalah isi dari file GeekController.cs sesuai dengan template yang dipilih.
1: using System;
2: using System.Collections.Generic;
3: using System.Linq;
4: using System.Net;
5: using System.Net.Http;
6: using System.Web.Http;
7:
8: public class GeekController : ApiController
9: {
10: // GET api/<controller>
11: public IEnumerable<string> Get()
12: {
13: return new string[] { "value1", "value2" };
14: }
15:
16: // GET api/<controller>/5
17: public string Get(int id)
18: {
19: return "value";
20: }
21:
22: // POST api/<controller>
23: public void Post([FromBody]string value)
24: {
25: }
26:
27: // PUT api/<controller>/5
28: public void Put(int id, [FromBody]string value)
29: {
30: }
31:
32: // DELETE api/<controller>/5
33: public void Delete(int id)
34: {
35: }
36: }
Kemudian perlu ditambahkan class WebApiConfig yang berfungsi untuk setting route Web API, dengan isi sebagai berikut :
1: using System;
2: using System.Collections.Generic;
3: using System.Linq;
4: using System.Net.Http.Headers;
5: using System.Web;
6: using System.Web.Http;
7:
8: /// <summary>
9: /// Summary description for WebApiConfig
10: /// </summary>
11: public static class WebApiConfig
12: {
13: public static void Register(HttpConfiguration config)
14: {
15: config.Routes.MapHttpRoute(
16: name: "DefaultApi",
17: routeTemplate: "api/{controller}/{id}",
18: defaults: new { id = RouteParameter.Optional }
19: );
20:
21: config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));
22: }
23: }
Pada baris ke-17 dapat dilihat “pola” URL yang akan kita tuliskan untuk mengakses fungsi-fungsi pada class controller yang dibuat. Dengan “pola” tersebut maka untuk memanfaatkan class GeekController.cs, maka perlu ditulis URL sebagai berikut :
http://[nama_domain]/api/Geek
Jadi jika class controller yang dibuat adalah PemiluController.cs maka URL yang harus ditulis adalah :
http://[nama_domain]/api/Pemilu
Catatan :
Awalnya pernah dibuat class dengan nama tidak mengikuti aturan akhiran “Controller”, misal GeekService.cs tetapi selalu error ketika memanggil layanan ini. Jadi “mungkin” memang harus mengikuti pola akhiran “Controller” pada nama class yang dibuat.
Kemudian pada baris ke-21, ditambahkan hal tersebut agar secara default output adalah JSON, agar developer tidak perlu repot lagi #DeveloperFriendly
Langkah selanjutnya adalah menambahkan file Global.asax pada project Website ini, dengan cara menambahkan item baru seperti yang telah dilakukan sebelumnya, yaitu Add > Add New Item kemudian pilih Global Application Class.
1: <%@ Application Language="C#" %>
2:
3: <script runat="server">
4:
5: void Application_Start(object sender, EventArgs e)
6: {
7: // Code that runs on application startup
8: WebApiConfig.Register(System.Web.Http.GlobalConfiguration.Configuration);
9: }
10:
11: void Application_End(object sender, EventArgs e)
12: {
13: // Code that runs on application shutdown
14:
15: }
16:
17: void Application_Error(object sender, EventArgs e)
18: {
19: // Code that runs when an unhandled error occurs
20:
21: }
22:
23: void Session_Start(object sender, EventArgs e)
24: {
25: // Code that runs when a new session is started
26:
27: }
28:
29: void Session_End(object sender, EventArgs e)
30: {
31: // Code that runs when a session ends.
32: // Note: The Session_End event is raised only when the sessionstate mode
33: // is set to InProc in the Web.config file. If session mode is set to StateServer
34: // or SQLServer, the event is not raised.
35:
36: }
37:
38: </script>
Yang perlu diperhatikan pada kode di atas adalah pemanggilan class WebApiConfig yang telah dibuat sebelumnya pada baris ke-18, yaitu berada pada method Application_Start.
{Testing}
Untuk testing cukup dengan memanggil nama controller dengan pola seperti yang telah dibuat pada setting di atas. Sebagai contoh :
http://localhost/api/Geek
Maka akan didapat output seperti berikut :
["value1","value2"]
Contoh lain adalah :
Maka akan didapat output seperti berikut :
"value"
Hasil yang kita lihat di atas sesuai dengan isi kedua method berikut ini :
public IEnumerable<string> Get(){ return new string[] { "value1", "value2" };} // GET api/<controller>/5public string Get(int id){ return "value";}
Nah jika kedua method tersebut diubah seperti ini :
public IEnumerable<string> Get(){ return new string[] { "Hallo", "ASP.NET Web API" };} // GET api/<controller>/5public string Get(string id){ return "Hello "+ id;}
Maka akan didapat output seperti berikut :
["Hallo","ASP.NET Web API"]
"Hello reza"
Selanjutnya silakan berkarya dengan format output sesuai keinginan (yang nanti akan diterangkan pada posting selanjutnya).
4 Comments + Add Comment
Got anything to say? Go ahead and leave a comment!
Recent Posts
- Menginstall Google Chrome Extension di Microsoft Edge
- Mudah Membuat Visualisasi Data Positif dan Kematian Akibat COVID-19 dengan Power BI #StayAtHome
- Read at Home: 3 Free Ebooks
- Memulai Membangun Aplikasi Desktop dengan WinForms .NET Core 3
- Seri Belajar ASP.NET: Membangun Aplikasi Real-Time dengan ASP.NET Core SignalR
- Seri Belajar Data Science: Pengenalan Azure Machine Learning Studio
- Azure Machine Learning Studio Workshop at Lampung University
Recent Comments
- ASP.NET MVC 5: Prepare Model for Data Access Layer on
- Seri Belajar ASP.NET : ASP.NET MVC Untuk Pemula on
- Seri Belajar ASP.NET : ASP.NET MVC Untuk Pemula on
- Seri Belajar ASP.NET : ASP.NET MVC Untuk Pemula on
- Seri Belajar ASP.NET : ASP.NET MVC Untuk Pemula on
- Kyodai, cara mudah dan cepat mengirim uang dari Jepang on
- Kyodai, cara mudah dan cepat mengirim uang dari Jepang on
Fotolia
ShutterStock
Archives
- July 2020 (1)
- April 2020 (1)
- March 2020 (1)
- June 2019 (1)
- January 2019 (2)
- November 2018 (1)
- March 2018 (6)
- December 2017 (1)
- October 2017 (1)
- August 2017 (1)
- July 2017 (2)
- April 2017 (1)
- March 2017 (5)
- February 2017 (8)
- January 2017 (4)
- December 2016 (1)
- October 2016 (2)
- August 2016 (4)
- July 2016 (1)
- June 2016 (1)
- May 2016 (2)
- April 2016 (5)
- February 2016 (10)
- January 2016 (5)
- December 2015 (2)
- October 2015 (1)
- September 2015 (3)
- August 2015 (1)
- July 2015 (2)
- June 2015 (1)
- May 2015 (1)
- April 2015 (3)
- January 2015 (4)
- December 2014 (7)
- November 2014 (3)
- September 2014 (3)
- August 2014 (1)
- June 2014 (1)
- May 2014 (2)
- April 2014 (6)
- March 2014 (10)
- February 2014 (4)
- January 2014 (3)
- December 2013 (3)
- October 2013 (1)
- September 2013 (3)
- August 2013 (1)
- June 2013 (2)
- May 2013 (1)
- April 2013 (3)
- March 2013 (6)
- February 2013 (2)
- January 2013 (3)
- November 2012 (4)
- October 2012 (2)
- May 2012 (2)
- March 2012 (1)
- March 2011 (1)
- February 2011 (1)
[…] : http://www.rezafaisal.net/?p=1049 Share this post: | | | | Posted: Mar 13 2014, 09:58 PM by reyza | with no comments Filed […]
[…] posting sebelumnya di http://www.rezafaisal.net/?p=1049, telah dijelaskan bagaimana menambahkan Web API Controller pada project ASP.NET Web Form. […]
[…] posting sebelumnya di http://www.rezafaisal.net/?p=1049, telah dijelaskan bagaimana menambahkan Web API Controller pada project ASP.NET Web Form. […]
[…] telah diterangkan bagaimana menambahkan Web API Controller pada project website ASP.NET Web Form (http://www.rezafaisal.net/?p=1049). Pada posting yang lain juga diterangkan bagaimana mengaktifkan SSL pada IIS Express via Visual […]