M365Con 2027 – konferensi online gratis · 11–22 Jan 2027 · 120 sessions m365con.net

API-first architecture

Concept

Arsitektur API-first merancang kemampuan bisnis sebagai API yang stabil dan dapat dipanggil sebelum antarmuka pengguna apa pun dibuat, sehingga antarmuka pengguna, mesin workflow, dan agen AI menggunakan operasi yang sama.

✦ CONCEPTAPI-first architectureM365.FM
Title graphic: API-first architecture (Concept)

Juga dibahas

Episode tentang API-first architecture itu juga membahas Computer-Using Agent (CUA), Foundry Agent Service, Service account, Agent observability, Microsoft Agent 365, dan Software as a service (SaaS).

Description

Arsitektur API-first adalah pendekatan desain di mana kemampuan bisnis didefinisikan sebagai API yang stabil dan dapat dipanggil sebelum antarmuka pengguna apa pun dibangun. Operasi yang sama kemudian dikonsumsi oleh antarmuka pengguna, mesin workflow, dan agen AI, alih-alih setiap klien mengakses logika melalui jalurnya sendiri. Dalam model ini, API diperlakukan sebagai keputusan produk, bukan produk sampingan dari kode, karena pengembang eksternal, mitra, dan agen AI diharapkan membangun di atasnya.

Elemen utama dalam pengembangan API-first adalah kontrak API. Menurut artikel Microsoft tentang pengembangan API-first, kontrak menjelaskan endpoint, data permintaan dan respons, serta kesalahan yang diharapkan, dan kontrak ditulis sebelum implementasi atau antarmuka pengguna. Kontrak biasanya dinyatakan dalam format yang dapat dibaca mesin, paling sering OpenAPI. Setelah kontrak disetujui, tim backend mengimplementasikannya sementara tim front-end dan mobile membangun berdasarkan mock yang dihasilkan darinya. Dokumentasi, SDK, dan pengujian dapat dihasilkan dari sumber yang sama, sehingga berbagai artefak tetap konsisten satu sama lain.

Pendekatan ini biasanya dibandingkan dengan pengembangan code-first. Dalam pengaturan code-first, API muncul dari kode yang sudah ada, yang dapat membocorkan detail internal ke antarmuka publik. API-first membalik urutan tersebut: antarmuka dirancang secara sengaja, dan kode ditulis untuk memenuhinya. Halaman Microsoft juga mencatat sejumlah trade-off. Pekerjaan contract-first menambah upaya peninjauan di awal, dan pendekatan code-first dapat dianggap wajar untuk alat internal awal ketika konsumennya sedikit dan antarmuka diperkirakan sering berubah. Halaman ini merupakan artikel vendor dan berisi konten khusus Azure.

Versioning merupakan bagian penting dari praktik ini. Karena konsumen bergantung pada kontrak, versioning diperlakukan sebagai kesepakatan dengan mereka: perubahan yang bersifat aditif dianggap aman dalam satu versi, sedangkan perubahan yang merusak memerlukan versi baru. Penghentian versi lama dapat ditandai dengan header Sunset, sehingga konsumen memiliki jalur yang jelas untuk bermigrasi alih-alih gangguan mendadak.

Karakteristik lain adalah satu API dapat melayani klien web, mobile, mitra, dan agen melalui satu gateway. Autentikasi dan pembatasan laju kemudian berlaku secara seragam untuk semua pemanggil, dan logika bisnis tidak perlu diduplikasi di berbagai saluran. Inilah alasan konsep ini relevan bagi sistem yang digerakkan agen, di mana agen perangkat lunak memerlukan operasi yang dapat diprediksi dan terdokumentasi untuk dipanggil.

Episode M365.FM "Computer-Using Agents: How CUA Could Transform SaaS" menghubungkan arsitektur API-first dengan ekosistem agen. Episode tersebut menyatakan bahwa ekosistem agen berkembang ketika arsitektur API-first diadopsi, karena memungkinkan perangkat lunak menghubungkan agen, sistem, dan workflow dengan jelas dan dapat diprediksi. Episode ini menggambarkan API yang stabil sebagai tulang punggung sistem cerdas, dan menyatakan bahwa pengembang dapat mengandalkannya untuk berinovasi tanpa khawatir akan gangguan. Episode ini juga menyoroti extensibility sebagai manfaat, yang membantu organisasi beradaptasi dengan kebutuhan yang terus berkembang. Dalam kerangka tersebut, desain API-first berjalan seiring dengan investasi pada workflow yang dapat dibuat, diotomatisasi, dan diskalakan oleh agen.

Keputusan umum seputar arsitektur API-first meliputi kemampuan mana yang akan diekspos sebagai API, format kontrak mana yang digunakan, bagaimana melakukan versioning dan deprecation perubahan, serta di mana menempatkan gateway untuk autentikasi dan pembatasan laju bersama. Tim juga menimbang biaya peninjauan kontrak di awal terhadap manfaat pekerjaan front-end dan backend yang berjalan paralel serta dokumentasi dan pengujian yang dihasilkan secara otomatis.

Overview compiled with AI from M365.FM episodes and the facts on this page. You can improve it with the edit button below.

TypeConcept
KindArchitecture

Frequently asked questions

Questions marked with AI were written with AI from the facts on this page.

Apa arti arsitektur API-first? (AI)

Artinya merancang kemampuan bisnis sebagai API yang stabil dan dapat dipanggil sebelum antarmuka pengguna apa pun, sehingga antarmuka pengguna, mesin workflow, dan agen AI semuanya menggunakan operasi yang sama. Kontrak API didefinisikan terlebih dahulu dan implementasi menyusul.

Bagaimana API-first berbeda dengan code-first? (AI)

Dalam pengembangan code-first, API merupakan produk sampingan dari kode yang sudah ada dan dapat membocorkan detail internal. Dalam pengembangan API-first, kontrak, yang biasanya ditulis dalam OpenAPI, dirancang dan disetujui sebelum implementasi atau antarmuka pengguna dibangun.

Mengapa API-first relevan bagi agen AI? (AI)

Episode "Computer-Using Agents: How CUA Could Transform SaaS" menyatakan bahwa API yang stabil menjadi tulang punggung sistem cerdas dan memungkinkan agen, sistem, serta workflow terhubung dengan jelas dan dapat diprediksi. Satu API di balik gateway juga dapat melayani klien agen sekaligus klien web dan mobile.

Glossary

Community wiki

Short info above, community knowledge below: add practical tips, examples or corrections. New contributions are reviewed first; trusted members publish directly.

Experts and companies for this topic

Nobody has listed this topic yet. Add it to your profile.

Maintained by Mirko Peters (Microsoft MVP) · Last updated: