API-first architecture
Concept
API-first архітектура проєктує бізнес-можливості як стабільні API, які можна викликати, до створення будь-якого користувацького інтерфейсу, щоб інтерфейси користувача, робочі процеси та AI-агенти використовували одні й ті самі операції.
Також обговорюють
У випуску на тему API-first architecture обговорюють також: Computer-Using Agent (CUA), Foundry Agent Service, Service account, Agent observability, Microsoft Agent 365 та Software as a service (SaaS).
Description
API-first архітектура — це підхід до проєктування, за якого бізнес-можливості визначаються як стабільні API, які можна викликати, до того, як створюється будь-який користувацький інтерфейс. Ті самі операції потім використовують інтерфейси користувача, робочі процеси та AI-агенти, замість того щоб кожен клієнт звертався до логіки власним шляхом. У цій моделі API розглядається як продуктове рішення, а не як побічний результат написання коду, адже зовнішні розробники, партнери та AI-агенти мають будувати на його основі.
Центральним елементом API-first розробки є контракт API. Згідно зі статтею Microsoft про API-first розробку, контракт описує кінцеві точки, дані запитів і відповідей та очікувані помилки, і пишеться він раніше за реалізацію або інтерфейс користувача. Контракт зазвичай подається у машинозчитуваному форматі, найчастіше OpenAPI. Після погодження контракту бекенд-команди реалізують його, а команди фронтенду та мобільних застосунків працюють з моками, згенерованими на його основі. Документація, SDK і тести можна створювати з того самого джерела, що допомагає підтримувати узгодженість різних артефактів.
Цей підхід часто протиставляють code-first розробці. За code-first підходу API виникає з наявного коду, що може розкривати внутрішні деталі в публічному інтерфейсі. API-first змінює цей порядок: інтерфейс проєктується свідомо, а код пишеться так, щоб його задовольнити. На сторінці Microsoft також згадано компроміси. Робота за принципом contract-first потребує додаткових зусиль на перевірку на початку, а code-first підхід може бути виправданим для раннього внутрішнього інструмента, де споживачів небагато і інтерфейс, імовірно, швидко змінюватиметься. Сторінка є статтею постачальника і містить контент, специфічний для Azure.
Версіонування є значною частиною практики. Оскільки споживачі залежать від контракту, версіонування розглядається як домовленість із ними: адитивні зміни всередині версії вважаються безпечними, тоді як руйнівні зміни потребують нової версії. Виведення старих версій з експлуатації можна позначати заголовком Sunset, що дає споживачам визначений шлях до міграції замість раптового збою.
Ще одна характерна риса полягає в тому, що один API може обслуговувати веб-, мобільних, партнерських клієнтів і клієнтів-агентів через єдиний шлюз. Тоді автентифікація та обмеження частоти запитів однаково застосовуються до всіх викликів, а бізнес-логіка не дублюється між окремими каналами. Саме тому ця концепція актуальна для систем на основі агентів, де програмним агентам потрібні передбачувані, задокументовані операції для виклику.
Епізод M365.FM «Computer-Using Agents: How CUA Could Transform SaaS» пов'язує API-first архітектуру з екосистемами агентів. В епізоді сказано, що екосистеми агентів розвиваються, коли впроваджується API-first архітектура, адже вона дозволяє з'єднувати агентів, системи та робочі процеси чітко і передбачувано. Стабільні API описуються як основа інтелектуальних систем, а розробники можуть покладатися на них, щоб створювати нове без страху перед збоями. Також вказано на розширюваність як перевагу, що допомагає організаціям адаптуватися до змінних вимог. У такому викладі API-first дизайн поєднується з інвестиціями в робочі процеси, які агенти можуть створювати, автоматизувати і масштабувати.
Типові рішення щодо API-first архітектури стосуються того, які можливості відкривати як API, який формат контракту використовувати, як версіонувати і виводити з експлуатації зміни та де розмістити шлюз для спільної автентифікації й обмеження частоти запитів. Команди також зважують початкові витрати на перевірку контракту проти переваг паралельної роботи фронтенду й бекенду, а також згенерованої документації та тестів.
Overview compiled with AI from M365.FM episodes and the facts on this page. You can improve it with the edit button below.
| Type | Concept |
|---|---|
| Kind | Architecture |
Frequently asked questions
Questions marked with AI were written with AI from the facts on this page.
Що означає API-first архітектура? (AI)
Це означає проєктування бізнес-можливостей як стабільних API, які можна викликати, до створення будь-якого користувацького інтерфейсу, щоб інтерфейси користувача, робочі процеси та AI-агенти всі використовували одні й ті самі операції. Спочатку визначається контракт API, а реалізація йде за ним.
Чим API-first відрізняється від code-first? (AI)
За code-first розробки API є побічним результатом наявного коду і може розкривати внутрішні деталі. За API-first розробки контракт, зазвичай написаний на OpenAPI, проєктується і погоджується до створення реалізації чи користувацького інтерфейсу.
Чому API-first актуальний для AI-агентів? (AI)
В епізоді «Computer-Using Agents: How CUA Could Transform SaaS» сказано, що стабільні API є основою інтелектуальних систем і дозволяють агентам, системам і робочим процесам з'єднуватися чітко та передбачувано. Один API за шлюзом може також обслуговувати клієнтів-агентів поряд із веб- і мобільними клієнтами.
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: