{"id":1052,"date":"2014-03-14T00:00:36","date_gmt":"2014-03-14T00:00:36","guid":{"rendered":"http:\/\/www.rezafaisal.net\/?p=1052"},"modified":"2014-03-22T00:44:58","modified_gmt":"2014-03-22T00:44:58","slug":"formating-asp-net-web-api-output","status":"publish","type":"post","link":"https:\/\/www.rezafaisal.net\/?p=1052","title":{"rendered":"Formating ASP.NET Web API Output"},"content":{"rendered":"

Pada posting sebelumnya di http:\/\/www.rezafaisal.net\/?p=1049<\/a>, telah dijelaskan bagaimana menambahkan Web API Controller pada project ASP.NET Web Form.\u00a0 Kemudian bagaimana cara untuk mengatur format output pada ASP.NET Web API?<\/p>\n

Sebenarnya format output ini tergantung dengan tipe data yang menjadi keluaran dari \u201cmethod\u201d yang dipanggil.\u00a0 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.\u00a0 Berikut adalah hal-hal yang akan kita lakukan.<\/p>\n

Pertama akan dibuat class Mahasiswa dengan kode seperti berikut :<\/p>\n

\n
\n
using<\/span> System;<\/pre>\n
<\/p>\n
using<\/span> System.Collections.Generic;<\/pre>\n
<\/p>\n
using<\/span> System.Linq;<\/pre>\n
<\/p>\n
using<\/span> System.Web;<\/pre>\n
<\/p>\n
<\/pre>\n
<\/p>\n
\/\/\/ <summary><\/span><\/pre>\n
<\/p>\n
\/\/\/ Summary description for Mahasiswa<\/span><\/pre>\n
<\/p>\n
\/\/\/ <\/summary><\/span><\/pre>\n
<\/p>\n
public<\/span> class<\/span> Mahasiswa<\/pre>\n
<\/p>\n
{<\/pre>\n
<\/p>\n
    public<\/span> string<\/span> NIM;<\/pre>\n
<\/p>\n
    public<\/span> string<\/span> Nama;<\/pre>\n
<\/p>\n
    public<\/span> string<\/span> Jurusan;<\/pre>\n
<\/p>\n
}<\/pre>\n
<\/p>\n<\/div>\n<\/div>\n
Nah sekarang kita akan memodifikasi GeekController.cs yang telah kita buat menjadi seperti berikut ini :<\/p>\n
\n
\n
public<\/span> IEnumerable<Mahasiswa> Get()<\/pre>\n
<\/p>\n
{<\/pre>\n
<\/p>\n
    List<Mahasiswa> data = new<\/span> List<Mahasiswa>();<\/pre>\n
<\/p>\n
<\/pre>\n
<\/p>\n
    Mahasiswa mhs1 = new<\/span> Mahasiswa();<\/pre>\n
<\/p>\n
    mhs1.NIM = \"1\"<\/span>;<\/pre>\n
<\/p>\n
    mhs1.Nama = \"Adi\"<\/span>;<\/pre>\n
<\/p>\n
    mhs1.Jurusan = \"Ilkom\"<\/span>;<\/pre>\n
<\/p>\n
    data.Add(mhs1);<\/pre>\n
<\/p>\n
<\/pre>\n
<\/p>\n
    Mahasiswa mhs2 = new<\/span> Mahasiswa();<\/pre>\n
<\/p>\n
    mhs2.NIM = \"2\"<\/span>;<\/pre>\n
<\/p>\n
    mhs2.Nama = \"Ida\"<\/span>;<\/pre>\n
<\/p>\n
    mhs2.Jurusan = \"Ilkom\"<\/span>;<\/pre>\n
<\/p>\n
    data.Add(mhs2);<\/pre>\n
<\/p>\n
<\/pre>\n
<\/p>\n
    Mahasiswa mhs3 = new<\/span> Mahasiswa();<\/pre>\n
<\/p>\n
    mhs3.NIM = \"3\"<\/span>;<\/pre>\n
<\/p>\n
    mhs3.Nama = \"Dia\"<\/span>;<\/pre>\n
<\/p>\n
    mhs3.Jurusan = \"Ilkom\"<\/span>;<\/pre>\n
<\/p>\n
    data.Add(mhs3);<\/pre>\n
<\/p>\n
<\/pre>\n
<\/p>\n
    return<\/span> data;<\/pre>\n
<\/p>\n
}<\/pre>\n
<\/p>\n<\/div>\n<\/div>\n
Dan berikut ini adalah output ketika GeekController.cs diakses via web :<\/p>\n
\n
\n
[<\/pre>\n
<\/p>\n
{\"NIM\"<\/span>:\"1\"<\/span>,\"Nama\"<\/span>:\"Adi\"<\/span>,\"Jurusan\"<\/span>:\"Ilkom\"<\/span>},<\/pre>\n
<\/p>\n
{\"NIM\"<\/span>:\"2\"<\/span>,\"Nama\"<\/span>:\"Ida\"<\/span>,\"Jurusan\"<\/span>:\"Ilkom\"<\/span>},<\/pre>\n
<\/p>\n
{\"NIM\"<\/span>:\"3\"<\/span>,\"Nama\"<\/span>:\"Dia\"<\/span>,\"Jurusan\"<\/span>:\"Ilkom\"<\/span>}<\/pre>\n
<\/p>\n
]<\/pre>\n
<\/p>\n<\/div>\n<\/div>\n
Dan berikut adalah output dengan format xml :<\/p>\n
\n
\n
<<\/span>ArrayOfMahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
    <<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>Jurusan<\/span>><\/span>Ilkom<\/<\/span>Jurusan<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>NIM<\/span>><\/span>1<\/<\/span>NIM<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>Nama<\/span>><\/span>Adi<\/<\/span>Nama<\/span>><\/span><\/pre>\n
<\/p>\n
    <\/<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
    <<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>Jurusan<\/span>><\/span>Ilkom<\/<\/span>Jurusan<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>NIM<\/span>><\/span>2<\/<\/span>NIM<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>Nama<\/span>><\/span>Ida<\/<\/span>Nama<\/span>><\/span><\/pre>\n
<\/p>\n
    <\/<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
    <<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>Jurusan<\/span>><\/span>Ilkom<\/<\/span>Jurusan<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>NIM<\/span>><\/span>3<\/<\/span>NIM<\/span>><\/span><\/pre>\n
<\/p>\n
        <<\/span>Nama<\/span>><\/span>Dia<\/<\/span>Nama<\/span>><\/span><\/pre>\n
<\/p>\n
    <\/<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
<\/<\/span>ArrayOfMahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n<\/div>\n<\/div>\n
Contoh selanjutnya adalah jika keluarannya hanya mengembalikan objek Mahasiswa saja, maka kita perlu ubah salah satu method pada GeekController.cs seperti berikut ini :<\/p>\n
\n
\n
public<\/span> Mahasiswa Get(string<\/span> id)<\/pre>\n
<\/p>\n
{<\/pre>\n
<\/p>\n
    Mahasiswa mhs1 = new<\/span> Mahasiswa();<\/pre>\n
<\/p>\n
    mhs1.NIM = \"1\"<\/span>;<\/pre>\n
<\/p>\n
    mhs1.Nama = \"Adi\"<\/span>;<\/pre>\n
<\/p>\n
    mhs1.Jurusan = \"Ilkom\"<\/span>;<\/pre>\n
<\/p>\n
<\/pre>\n
<\/p>\n
    return<\/span> mhs1;<\/pre>\n
<\/p>\n
}<\/pre>\n
<\/p>\n<\/div>\n<\/div>\n
Maka dapat kita lihat outputnya seperti berikut ini :<\/p>\n
\n
\n
{<\/pre>\n
<\/p>\n
    \"NIM\"<\/span>:\"1\"<\/span>,<\/pre>\n
<\/p>\n
    \"Nama\"<\/span>:\"Adi\"<\/span>,<\/pre>\n
<\/p>\n
    \"Jurusan\"<\/span>:\"Ilkom\"<\/span><\/pre>\n
<\/p>\n
}<\/pre>\n
<\/p>\n<\/div>\n<\/div>\n
atau dengan format XML :<\/p>\n
\n
\n
<<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n
    <<\/span>Jurusan<\/span>><\/span>Ilkom<\/<\/span>Jurusan<\/span>><\/span><\/pre>\n
<\/p>\n
    <<\/span>NIM<\/span>><\/span>1<\/<\/span>NIM<\/span>><\/span><\/pre>\n
<\/p>\n
    <<\/span>Nama<\/span>><\/span>Adi<\/<\/span>Nama<\/span>><\/span><\/pre>\n
<\/p>\n
<\/<\/span>Mahasiswa<\/span>><\/span><\/pre>\n
<\/p>\n<\/div>\n<\/div>\n
Nah dengan format seperti ini developer akan dengan mudah \u201cmengekstrak\u201d data dengan JSON Parser atau XML Parser yang telah tersedia saat ini. #DeveloperFriendly<\/p>\n
Selamat mencoba.<\/p>\n","protected":false},"excerpt":{"rendered":"
Pada posting sebelumnya di http:\/\/www.rezafaisal.net\/?p=1049, telah dijelaskan bagaimana menambahkan Web API Controller pada project ASP.NET Web Form.\u00a0 Kemudian bagaimana cara untuk mengatur format output pada ASP.NET Web API? Sebenarnya format output ini tergantung dengan tipe data yang menjadi keluaran dari…<\/p>\n","protected":false},"author":1,"featured_media":1091,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[6],"tags":[68,96,108],"class_list":["post-1052","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-softwaredev","tag-asp-net","tag-vs-2013","tag-web-api"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"https:\/\/www.rezafaisal.net\/wp-content\/uploads\/2014\/03\/asp-dot-net-logo.gif","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p1sNAL-gY","_links":{"self":[{"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts\/1052","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1052"}],"version-history":[{"count":2,"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts\/1052\/revisions"}],"predecessor-version":[{"id":1092,"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts\/1052\/revisions\/1092"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/media\/1091"}],"wp:attachment":[{"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1052"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1052"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1052"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}