{"id":11188,"date":"2018-05-31T00:00:00","date_gmt":"2018-05-31T00:00:00","guid":{"rendered":"https:\/\/binus.ac.id\/binus-digital\/2018\/05\/31\/merancang-web-api-yang-mudah-dieksplorasi\/"},"modified":"2024-09-24T02:20:30","modified_gmt":"2024-09-24T02:20:30","slug":"merancang-web-api-yang-mudah-dieksplorasi","status":"publish","type":"post","link":"https:\/\/binus.ac.id\/binus-digital\/2018\/05\/31\/merancang-web-api-yang-mudah-dieksplorasi\/","title":{"rendered":"Merancang Web API yang Mudah Dieksplorasi"},"content":{"rendered":"

Meningkatnya jumlah aplikasi software<\/em> (App<\/em>) pada berbagai macam perangkat komputasi tentu memerlukan layanan dari berbagai sumber (Verborgh et al, 2015). Sebagai contoh, layanan Facebook API<\/em> menyediakan layanan untuk melakukan sign in<\/em> ke dalam sebuah App<\/em> tanpa mengharuskan pengguna untuk melakukan pendaftaran baru ke dalam App<\/em>. App<\/em> akan mengkonsumsi layanan Facebook API<\/em> untuk melakukan authentikasi dan izin untuk mendapatkan beberapa data dari Facebook<\/em> untuk digunakan pada App<\/em>. Facebook API<\/em> adalah salah satu contoh dari berbagai jenis Web API<\/em> yang tersedia di Web<\/em> dan dapat dikonsumsi oleh berbagai client App<\/em>.<\/p>\n

Web API<\/em> adalah sebuah software<\/em> yang menyediakan layanan (fungsi-fungsi) spesifik yang dapat dipanggil melalui Web<\/em> oleh berbagai jenis software<\/em> lain. Web service<\/em> adalah salah satu bentuk dari tradisional Web API<\/em>, umumnya terdapat kontrak berupa sebuah dokumen Web Service Definition Language (WSDL)<\/em> yang berisi fungsi-fungsi apa saja yang dapat dipanggil dan dieksekusi oleh Web<\/em> service<\/em> tersebut. Perkembangan selanjutnya adalah arsitektur REST<\/em> (Representational State Transfer<\/em>) API<\/em> yang diperkenalkan oleh Fielding dan Taylor (2002). Sampai saat ini REST<\/em> API<\/em> sangat populer dan diimplementasikan pada banyak\u00a0Web API<\/em>.<\/p>\n

Mengapa REST API<\/em> menjadi lebih superior dibandingkan dengan\u00a0Web service<\/em> tradisional? Menurut Verborgh et al (2015), API<\/em> yang mengikuti prinsip REST<\/em> adalah “native Web citizens<\/em>” ini berarti API<\/em> tersebut bekerja sesuai dengan prinsip kerja Web<\/em>. Fielding dan Taylor (2008) menyebutkan bahwa REST<\/em> mempunyai beberapa prinsip fundamental sebagai berikut:<\/p>\n

    \n
  1. Berorientasi pada resource<\/em> dan addressability<\/em><\/strong>
    \nSeluruh bit informasi harus dibungkus dalam sebuah resource yang dapat diakses melalui penanda yang stabil. Penanda ini disebut dengan URL<\/em> dan resource diakses melalui HTTP<\/em>.
    \nContoh:
    \nURL<\/em> endpoint<\/em> utama:
    \nhttps:\/\/api.example.com\/<\/span>
    \nURL kumpulan resource<\/em> pengguna:
    \nhttps:\/\/api.example.com\/user<\/span>
    \nURL resource pengguna\u00a0spesifik dengan ID 1001:
    \nhttps:\/\/api.example.com\/user\/1001<\/span>
    \nURL kumpulan buku milik pengguna spesifik dengan ID 1001:
    \nhttps:\/\/api.example.com\/user\/1001\/book<\/span>
     <\/li>\n
  2. Penggunaan interface<\/em> yang seragam<\/strong>
    \nArsitektur REST<\/em> memiliki interface<\/em> yang seragam untuk dapat mengakses sebuah resource<\/em> dari URL<\/em>. Interface<\/em> ini disebut dengan HTTP verbs<\/em> yang dijabarkan pada tabel berikut:<\/p>\n\n\n\n\n\n\n\n\n\n\n
    HTTP Verb<\/em><\/th>\nDeskripsi<\/th>\n<\/tr>\n
    GET<\/em><\/td>\nMengambil sebuah representasi resource<\/em><\/td>\n<\/tr>\n
    HEAD<\/em><\/td>\nMengambil informasi header<\/em> resource<\/em><\/td>\n<\/tr>\n
    OPTIONS<\/em><\/td>\nMengambil daftar verbs<\/em> yang didukung oleh resource<\/em> ini<\/td>\n<\/tr>\n
    PUT<\/em><\/td>\nMengganti resource<\/em><\/td>\n<\/tr>\n
    DELETE<\/em><\/td>\nMenghapus resource<\/em><\/td>\n<\/tr>\n
    PATCH<\/em><\/td>\nMemperbaharui state<\/em> dari resource<\/em><\/td>\n<\/tr>\n
    POST<\/em><\/td>\nMembuat resource<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
  3. Representasi resource<\/em> dan tipe media<\/strong>
    \nResource<\/em> yang direpresentasikan dapat menyesuaikan dengan kemampuan client<\/em>, contoh HTML, XML<\/em>, atau JSON<\/em>.
     <\/li>\n
  4. Hypermedia as the Engine of Application State (HATEOAS)<\/em><\/strong>
    \nResource<\/em> harus memiliki hyperlink<\/em> atau form<\/em>, untuk berpindah ke state<\/em> aplikasi berikutnya dan menampilkan resource<\/em> yang berbeda.<\/li>\n<\/ol>\n

    REST API<\/em> yang memanfaatkan prinsip HATEOAS<\/em> memiliki keuntungan<\/strong> bagi software developer<\/em>. Sebuah REST<\/em> API<\/em> memiliki satu endpoint<\/em> utama (URL<\/em>) yang dapat diakses, selanjutnya dapat dieksplorasi seperti halnya melakukan browsing<\/em> pada Web<\/em>. Resources<\/em> dapat dengan mudah ditelusuri dan ditemukan melalui hyperlinks<\/em>, serta juga dapat dimanipulasi dengan menggunakan HTTP verbs<\/em> (Amundsen, 2010).<\/p>\n

    Demikian sekilas mengenai teori dan prinsip terkait perancangan Web API<\/em> yang mudah dieksplorasi. Pada artikel selanjutnya akan dibahas lebih lanjut mengenai implementasi dari arsitektur REST API<\/em> memanfaatkan prinsip HATEOAS<\/em>.<\/p>\n

    Referensi:<\/h4>\n

    Amundsen, M. (2010, May 31). H Factor: Hypermedia Types<\/em>. Retrieved Jan 20, 2014, from Amundsen: http:\/\/www.amundsen.com\/hypermedia\/hfactor\/<\/p>\n

    Fielding, R. T. 2008. REST APIs must be hypertext-driven<\/em>. Untangled \u2013 Musings of Roy T. Fielding. from: http:\/\/roy.gbiv.com\/untangled\/2008\/rest-apis-must-be-hypertext-driven<\/p>\n

    Fielding, R. T. and Taylor, R. N. 2002. Principled design of the modern Web architecture. Transactions on Internet Technology 2<\/em>, 2 (May), 115\u2013150.<\/p>\n

    Gamache, P. (2014). Pragmatic Hypermedia: Creating a Generic, Self-inflating API Client for Production Use. Proceedings of the 23rd International Conference on World Wide Web<\/em> (pp. 931-936). Seoul: ACM.<\/p>\n

    Verborgh, R., Arndt, D., Van Hoecke, S., De Roo, J., Mels, G., Steiner, T., & Gabarro, J. (2017). The pragmatic proof: Hypermedia API composition and execution. Theory and Practice of Logic Programming<\/em>, 17(1), 1-48.<\/p>\n

    ++++++++++<\/p>\n

    Photo by\u00a0Tran Mau Tri Tam<\/a>\u00a0on\u00a0Unsplash<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

    Meningkatnya jumlah aplikasi software (App) pada berbagai macam perangkat komputasi tentu memerlukan layanan dari berbagai sumber (Verborgh et al, 2015). Sebagai contoh, layanan Facebook API menyediakan layanan untuk melakukan sign in ke dalam sebuah App tanpa mengharuskan pengguna untuk melakukan pendaftaran baru ke dalam App. App akan mengkonsumsi layanan Facebook API untuk melakukan authentikasi dan […]<\/p>\n","protected":false},"author":19,"featured_media":11189,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[77],"tags":[],"class_list":["post-11188","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-articles"],"_links":{"self":[{"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/posts\/11188","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/users\/19"}],"replies":[{"embeddable":true,"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/comments?post=11188"}],"version-history":[{"count":1,"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/posts\/11188\/revisions"}],"predecessor-version":[{"id":12005,"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/posts\/11188\/revisions\/12005"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/media\/11189"}],"wp:attachment":[{"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/media?parent=11188"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/categories?post=11188"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/binus.ac.id\/binus-digital\/wp-json\/wp\/v2\/tags?post=11188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}