Formating ASP.NET Web API Output
Pada posting sebelumnya di http://www.rezafaisal.net/?p=1049, telah dijelaskan bagaimana menambahkan Web API Controller pada project ASP.NET Web Form. Kemudian bagaimana cara untuk mengatur format output pada ASP.NET Web API?
Sebenarnya format output ini tergantung dengan tipe data yang menjadi keluaran dari “method” yang dipanggil. Pada posting sebelumnya, kita hanya menggunakan tipe data primitif string dan array of string. Nah bagaimana kalau misalnya outputnya berupa objek dari suatu class atau suatu collection yang berisi objek-objek dari class tertentu? Bagaimana kira-kira format output yang akan kita lihat? Untuk mengetahui hal itu maka kita akan coba melakukan beberapa pengujian. Berikut adalah hal-hal yang akan kita lakukan.
Pertama akan dibuat class Mahasiswa dengan kode seperti berikut :
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
/// <summary>
/// Summary description for Mahasiswa
/// </summary>
public class Mahasiswa
{
public string NIM;
public string Nama;
public string Jurusan;
}
Nah sekarang kita akan memodifikasi GeekController.cs yang telah kita buat menjadi seperti berikut ini :
public IEnumerable<Mahasiswa> Get()
{
List<Mahasiswa> data = new List<Mahasiswa>();
Mahasiswa mhs1 = new Mahasiswa();
mhs1.NIM = "1";
mhs1.Nama = "Adi";
mhs1.Jurusan = "Ilkom";
data.Add(mhs1);
Mahasiswa mhs2 = new Mahasiswa();
mhs2.NIM = "2";
mhs2.Nama = "Ida";
mhs2.Jurusan = "Ilkom";
data.Add(mhs2);
Mahasiswa mhs3 = new Mahasiswa();
mhs3.NIM = "3";
mhs3.Nama = "Dia";
mhs3.Jurusan = "Ilkom";
data.Add(mhs3);
return data;
}
Dan berikut ini adalah output ketika GeekController.cs diakses via web :
[
{"NIM":"1","Nama":"Adi","Jurusan":"Ilkom"},
{"NIM":"2","Nama":"Ida","Jurusan":"Ilkom"},
{"NIM":"3","Nama":"Dia","Jurusan":"Ilkom"}
]
Dan berikut adalah output dengan format xml :
<ArrayOfMahasiswa>
<Mahasiswa>
<Jurusan>Ilkom</Jurusan>
<NIM>1</NIM>
<Nama>Adi</Nama>
</Mahasiswa>
<Mahasiswa>
<Jurusan>Ilkom</Jurusan>
<NIM>2</NIM>
<Nama>Ida</Nama>
</Mahasiswa>
<Mahasiswa>
<Jurusan>Ilkom</Jurusan>
<NIM>3</NIM>
<Nama>Dia</Nama>
</Mahasiswa>
</ArrayOfMahasiswa>
Contoh selanjutnya adalah jika keluarannya hanya mengembalikan objek Mahasiswa saja, maka kita perlu ubah salah satu method pada GeekController.cs seperti berikut ini :
public Mahasiswa Get(string id)
{
Mahasiswa mhs1 = new Mahasiswa();
mhs1.NIM = "1";
mhs1.Nama = "Adi";
mhs1.Jurusan = "Ilkom";
return mhs1;
}
Maka dapat kita lihat outputnya seperti berikut ini :
{
"NIM":"1",
"Nama":"Adi",
"Jurusan":"Ilkom"
}
atau dengan format XML :
<Mahasiswa>
<Jurusan>Ilkom</Jurusan>
<NIM>1</NIM>
<Nama>Adi</Nama>
</Mahasiswa>
Nah dengan format seperti ini developer akan dengan mudah “mengekstrak” data dengan JSON Parser atau XML Parser yang telah tersedia saat ini. #DeveloperFriendly
Selamat mencoba.
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)