{"id":1406,"date":"2014-09-09T08:32:47","date_gmt":"2014-09-09T08:32:47","guid":{"rendered":"http:\/\/www.rezafaisal.net\/?p=1406"},"modified":"2014-09-09T08:35:56","modified_gmt":"2014-09-09T08:35:56","slug":"asp-net-web-api-tips-part-i","status":"publish","type":"post","link":"http:\/\/www.rezafaisal.net\/?p=1406","title":{"rendered":"ASP.NET Web API Tips (Part I)"},"content":{"rendered":"

{Format Output XML atau JSON<\/em><\/strong>}<\/p>\n

Sebagai informasi format outpun dari ASP.NET Web API dapat berupa format XML atau JSON, hal ini tergantung permintaan dari client yang mengakses.  Jika menggunakan web browser seperti Internet Explorer, Firefox atau Chrome. Jika pernah menggunakan web browser tersebut maka dapat kita akan dapat melihat ada perbedaan format data yang diberikan. Jika menggunakan IE biasanya output yang diberikan berupa format JSON. Sedangkan format output XML akan diberikan jika menggunakan web browser Firefox dan Chrome.<\/p>\n

Tetapi jika tipe format output yang diinginkan pada web browser dapat ditentukan oleh user yang mengaksesnya dengan menggunakan query string dari url akses, maka kita sebagai programmer dapat menambahkan dua baris berikut ini pada file Global.asax.cs seperti pada baris ke-9 dan ke-10 di bawah ini.<\/p>\n

\n
\n
   1:<\/span> protected<\/span> void<\/span> Application_Start()<\/pre>\n
<\/p>\n
   2:<\/span> {<\/pre>\n
<\/p>\n
   3:<\/span>     AreaRegistration.RegisterAllAreas();<\/pre>\n
<\/p>\n
   4:<\/span>     GlobalConfiguration.Configure(WebApiConfig.Register);<\/pre>\n
<\/p>\n
   5:<\/span>     FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);<\/pre>\n
<\/p>\n
   6:<\/span>     RouteConfig.RegisterRoutes(RouteTable.Routes);<\/pre>\n
<\/p>\n
   7:<\/span>     BundleConfig.RegisterBundles(BundleTable.Bundles);<\/pre>\n
<\/p>\n
   8:<\/span>  <\/pre>\n
<\/p>\n
   9:<\/span>     GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(new<\/span> QueryStringMapping("type"<\/span>, "json"<\/span>, new<\/span> MediaTypeHeaderValue("application\/json"<\/span>)));<\/pre>\n
<\/p>\n
  10:<\/span>     GlobalConfiguration.Configuration.Formatters.XmlFormatter.MediaTypeMappings.Add(new<\/span> QueryStringMapping("type"<\/span>, "xml"<\/span>, new<\/span> MediaTypeHeaderValue("application\/xml"<\/span>)));<\/pre>\n
<\/p>\n
  11:<\/span> }<\/pre>\n
<\/div>\n<\/div>\n
Setelah itu maka pada web browser dapat ditulis dengan sintaks berikut ini untuk mendapatkan output dengan format XML :<\/p>\n
\n
\n
http:\/\/[hostname]\/api\/[controller-name]?type=xml<\/pre>\n
<\/div>\n<\/div>\n
Sedangkan jika ingin mendapatkan output dengan format JSON maka digunakan format url seperti berikut ini :<\/p>\n
\n
\n
http:\/\/[hostname]\/api\/[controller-name]?type=json<\/pre>\n
<\/div>\n<\/div>\n
{Issue Penggunaan Relasi Model pada Entity Framework<\/em><\/strong>}<\/p>\n
Bagi yang pernah menggunakan Entity Framework sebagai data access dan mempublish datanya dengan Web API maka mungkin akan bertemu masalah ini. Masalah ini biasanya terjadi ketika ada relasi antar model seperti pada gambar berikut ini :<\/p>\n
\"blog01\"<\/a><\/p>\n
Dan jika kita membuat controller untuk menampilkan data Jurusan dengan cara seperti berikut ini :<\/p>\n
\n
\n
   1:<\/span> [HttpGet]<\/pre>\n
<\/p>\n
   2:<\/span> public<\/span> List<Jurusan> Get()<\/pre>\n
<\/p>\n
   3:<\/span> {<\/pre>\n
<\/p>\n
   4:<\/span>     List<Jurusan> data = new<\/span> List<Jurusan>();<\/pre>\n
<\/p>\n
   5:<\/span>     try<\/span><\/pre>\n
<\/p>\n
   6:<\/span>     {<\/pre>\n
<\/p>\n
   7:<\/span>         AkademikDBEntities db = new<\/span> AkademikDBEntities();<\/pre>\n
<\/p>\n
   8:<\/span>         data = db.Jurusans.Select(p => p).ToList();<\/pre>\n
<\/p>\n
   9:<\/span>     }<\/pre>\n
<\/p>\n
  10:<\/span>     catch<\/span> { }<\/pre>\n
<\/p>\n
  11:<\/span>  <\/pre>\n
<\/p>\n
  12:<\/span>     return<\/span> data;<\/pre>\n
<\/p>\n
  13:<\/span> }<\/pre>\n
<\/div>\n<\/div>\n
Maka ketika controller itu diakses via web browser dapat dilihat output error seperti berikut ini :<\/p>\n
\"blog02\"<\/a><\/p>\n
Hal ini kemungkinan terjadi karena data pada Jurusan terkait dengan data pada Mahasiswa. <\/p>\n
Jika hal seperti itu terjadi ada beberapa tip untuk mengatasinya. Yang pertama dengan cara melakukan modifikasi file class model yang mempunyai relasi ke model lain menjadi seperti berikut ini :<\/p>\n
\n
\n
   1:<\/span> namespace<\/span> WebAPI.Akademik<\/pre>\n
<\/p>\n
   2:<\/span> {<\/pre>\n
<\/p>\n
   3:<\/span>     using<\/span> Newtonsoft.Json;<\/pre>\n
<\/p>\n
   4:<\/span>     using<\/span> System;<\/pre>\n
<\/p>\n
   5:<\/span>     using<\/span> System.Collections.Generic;<\/pre>\n
<\/p>\n
   6:<\/span>     <\/pre>\n
<\/p>\n
   7:<\/span>     public<\/span> partial<\/span> class<\/span> Jurusan<\/pre>\n
<\/p>\n
   8:<\/span>     {<\/pre>\n
<\/p>\n
   9:<\/span>         public<\/span> Jurusan()<\/pre>\n
<\/p>\n
  10:<\/span>         {<\/pre>\n
<\/p>\n
  11:<\/span>             this<\/span>.Mahasiswas = new<\/span> HashSet<Mahasiswa>();<\/pre>\n
<\/p>\n
  12:<\/span>         }<\/pre>\n
<\/p>\n
  13:<\/span>     <\/pre>\n
<\/p>\n
  14:<\/span>         public<\/span> int<\/span> JurusanID { get; set; }<\/pre>\n
<\/p>\n
  15:<\/span>         public<\/span> string<\/span> NamaJurusan { get; set; }<\/pre>\n
<\/p>\n
  16:<\/span>  <\/pre>\n
<\/p>\n
  17:<\/span>         [JsonIgnore]<\/pre>\n
<\/p>\n
  18:<\/span>         public<\/span> virtual<\/span> ICollection<Mahasiswa> Mahasiswas { get; set; }<\/pre>\n
<\/p>\n
  19:<\/span>     }<\/pre>\n
<\/p>\n
  20:<\/span> }<\/pre>\n
<\/div>\n<\/div>\n
Pada bari ke-18 dapat dilihat relasi class model ini berlasi dengan class model Mahasiswa. Nah solusinya cukup tambahkan atribut [JsonIgnore] diatas baris tersebut. Sayangnya solusi ini hanya berlakuk jika format outputnya adalah JSON.<\/p>\n
Nah ada cara lain melepas relasi ini, dengan cara membuat class "model salinan" dari class model Jurusan, dengan kode seperti berikut :<\/p>\n
\n
\n
   1:<\/span> using<\/span> System;<\/pre>\n
<\/p>\n
   2:<\/span> using<\/span> System.Collections.Generic;<\/pre>\n
<\/p>\n
   3:<\/span> using<\/span> System.Linq;<\/pre>\n
<\/p>\n
   4:<\/span> using<\/span> System.Web;<\/pre>\n
<\/p>\n
   5:<\/span>  <\/pre>\n
<\/p>\n
   6:<\/span> namespace<\/span> WebAPI.Akademik.Controllers<\/pre>\n
<\/p>\n
   7:<\/span> {<\/pre>\n
<\/p>\n
   8:<\/span>     public<\/span> class<\/span> JurusanModel<\/pre>\n
<\/p>\n
   9:<\/span>     {<\/pre>\n
<\/p>\n
  10:<\/span>         public<\/span> int<\/span> JurusanID { set; get; }<\/pre>\n
<\/p>\n
  11:<\/span>         public<\/span> string<\/span> NamaJurusan { set; get; }<\/pre>\n
<\/p>\n
  12:<\/span>     }<\/pre>\n
<\/p>\n
  13:<\/span> }<\/pre>\n
<\/div>\n<\/div>\n
Kemudian pada controller bisa digunakan kode seperti berikut ini :<\/p>\n
\n
\n
   1:<\/span> [HttpGet]<\/pre>\n
<\/p>\n
   2:<\/span> public<\/span> List<JurusanModel> Get()<\/pre>\n
<\/p>\n
   3:<\/span> {<\/pre>\n
<\/p>\n
   4:<\/span>     List<JurusanModel> data = new<\/span> List<JurusanModel>();<\/pre>\n
<\/p>\n
   5:<\/span>     try<\/span><\/pre>\n
<\/p>\n
   6:<\/span>     {<\/pre>\n
<\/p>\n
   7:<\/span>         AkademikDBEntities db = new<\/span> AkademikDBEntities();<\/pre>\n
<\/p>\n
   8:<\/span>         var datatemp = db.Jurusans.Select(p => p).ToList();<\/pre>\n
<\/p>\n
   9:<\/span>         foreach<\/span>(Jurusan j in<\/span> datatemp)<\/pre>\n
<\/p>\n
  10:<\/span>         {<\/pre>\n
<\/p>\n
  11:<\/span>             JurusanModel jm = new<\/span> JurusanModel();<\/pre>\n
<\/p>\n
  12:<\/span>             jm.JurusanID = j.JurusanID;<\/pre>\n
<\/p>\n
  13:<\/span>             jm.NamaJurusan = j.NamaJurusan;<\/pre>\n
<\/p>\n
  14:<\/span>             data.Add(jm);<\/pre>\n
<\/p>\n
  15:<\/span>         }<\/pre>\n
<\/p>\n
  16:<\/span>     }<\/pre>\n
<\/p>\n
  17:<\/span>     catch<\/span> { }<\/pre>\n
<\/p>\n
  18:<\/span>  <\/pre>\n
<\/p>\n
  19:<\/span>     return<\/span> data;<\/pre>\n
<\/p>\n
  20:<\/span> }<\/pre>\n
<\/div>\n<\/div>\n
Dengan cara ini maka issue di atas dapat diatasi dan mampu mengeluarkan output dengan format XML dan JSON.<\/p>\n
Semoga bermanfaat.<\/p>\n","protected":false},"excerpt":{"rendered":"
{Format Output XML atau JSON} Sebagai informasi format outpun dari ASP.NET Web API dapat berupa format XML atau JSON, hal ini tergantung permintaan dari client yang mengakses.  Jika menggunakan web browser seperti Internet Explorer, Firefox atau Chrome. Jika pernah menggunakan…<\/p>\n","protected":false},"author":1,"featured_media":1403,"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":[70,108],"class_list":["post-1406","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-softwaredev","tag-entity-framework","tag-web-api"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"http:\/\/www.rezafaisal.net\/wp-content\/uploads\/2014\/09\/blog01_thumb.jpg","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p1sNAL-mG","_links":{"self":[{"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts\/1406","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1406"}],"version-history":[{"count":1,"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts\/1406\/revisions"}],"predecessor-version":[{"id":1407,"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/posts\/1406\/revisions\/1407"}],"wp:featuredmedia":[{"embeddable":true,"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=\/wp\/v2\/media\/1403"}],"wp:attachment":[{"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1406"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1406"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.rezafaisal.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1406"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}