M365Con 2027 – bezpłatna konferencja online · 11–22 Jan 2027 · 120 sessions m365con.net

API-first architecture

Concept

Architektura API-first projektuje zdolności biznesowe jako stabilne, wywoływalne interfejsy API jeszcze przed powstaniem interfejsu użytkownika, tak aby interfejsy użytkownika, silniki przepływów pracy i agenci AI korzystali z tych samych operacji.

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

Omawiane również

W odcinku na temat API-first architecture pojawiają się też: Computer-Using Agent (CUA), Foundry Agent Service, Service account, Agent observability, Microsoft Agent 365 i Software as a service (SaaS).

Opis

Architektura API-first to podejście projektowe, w którym zdolności biznesowe są definiowane jako stabilne, wywoływalne interfejsy API, zanim zostanie zbudowany jakikolwiek interfejs użytkownika. Te same operacje są następnie wykorzystywane przez interfejsy użytkownika, silniki przepływów pracy i agentów AI, zamiast tego, by każdy klient docierał do logiki własną drogą. W tym modelu API traktuje się jako decyzję produktową, a nie efekt uboczny kodu, ponieważ zewnętrzni deweloperzy, partnerzy i agenci AI mają na nim budować.

Kluczowym elementem tworzenia w podejściu API-first jest kontrakt API. Zgodnie z artykułem Microsoft o tworzeniu API-first kontrakt opisuje punkty końcowe, dane żądań i odpowiedzi oraz oczekiwane błędy, a jest pisany przed implementacją lub interfejsem użytkownika. Kontrakt zwykle zapisuje się w formacie czytelnym dla maszyn, najczęściej w OpenAPI. Po zatwierdzeniu kontraktu zespoły backendowe go implementują, a zespoły front-endowe i mobilne tworzą swoje rozwiązania na podstawie mocków wygenerowanych z tego kontraktu. Dokumentację, zestawy SDK i testy można generować z tego samego źródła, co utrzymuje spójność różnych artefaktów.

Podejście to często zestawia się z podejściem code-first. W konfiguracji code-first API wyłania się z istniejącego kodu, co może ujawniać wewnętrzne szczegóły w interfejsie publicznym. API-first odwraca tę kolejność: interfejs jest projektowany świadomie, a kod pisze się tak, by go spełniał. Strona Microsoft wskazuje też na kompromisy. Praca kontraktowa wymaga wcześniejszego wysiłku recenzyjnego, a podejście code-first może być rozsądne we wczesnym wewnętrznym narzędziu, gdzie konsumentów jest niewielu, a interfejs ma się szybko zmieniać. Strona jest artykułem dostawcy i zawiera treści specyficzne dla Azure.

Wersjonowanie jest istotną częścią tej praktyki. Ponieważ konsumenci zależą od kontraktu, wersjonowanie traktuje się jako umowę z nimi: zmiany addytywne są uznawane za bezpieczne w obrębie wersji, a zmiany powodujące niezgodność wymagają nowej wersji. Wycofywanie starszych wersji można sygnalizować nagłówkiem Sunset, dając konsumentom określoną ścieżkę migracji zamiast nagłego zakłócenia działania.

Kolejną cechą jest to, że jedno API może obsługiwać klientów webowych, mobilnych, partnerskich i agentowych za pośrednictwem jednej bramy. Uwierzytelnianie i ograniczanie liczby żądań obowiązują wtedy jednolicie wobec wszystkich wywołujących, a logika biznesowa nie jest powielana w osobnych kanałach. To sprawia, że koncepcja jest istotna dla systemów sterowanych przez agentów, gdzie agenty programowe potrzebują przewidywalnych, udokumentowanych operacji do wywoływania.

Epizod M365.FM "Computer-Using Agents: How CUA Could Transform SaaS" łączy architekturę API-first z ekosystemami agentów. Epizod mówi, że ekosystemy agentów rozwijają się dobrze, gdy przyjęta jest architektura API-first, ponieważ pozwala ona łączyć agenty, systemy i przepływy pracy w sposób jasny i przewidywalny. Opisuje stabilne API jako kręgosłup inteligentnych systemów i podkreśla, że deweloperzy mogą na nich polegać, by innowować bez obawy o zakłócenia. Wskazuje także na rozszerzalność jako zaletę, pomagającą organizacjom dostosowywać się do zmieniających się wymagań. W tym ujęciu projektowanie API-first występuje obok inwestycji w przepływy pracy, które agenty mogą tworzyć, automatyzować i skalować.

Typowe decyzje dotyczące architektury API-first obejmują to, które zdolności udostępnić jako API, jakiego formatu kontraktu użyć, jak wersjonować i wycofywać zmiany oraz gdzie umieścić bramę do wspólnego uwierzytelniania i ograniczania liczby żądań. Zespoły rozważają też koszt wstępnego przeglądu kontraktu w zestawieniu z korzyściami równoległej pracy front-endu i backendu oraz generowanej dokumentacji i testów.

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

TypConcept
KindArchitecture

Często zadawane pytania

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

Co oznacza architektura API-first? (AI)

Oznacza to projektowanie zdolności biznesowych jako stabilnych, wywoływalnych interfejsów API, zanim powstanie jakikolwiek interfejs użytkownika, tak aby interfejsy użytkownika, silniki przepływów pracy i agenci AI korzystali z tych samych operacji. Kontrakt API jest definiowany jako pierwszy, a implementacja następuje później.

Czym API-first różni się od code-first? (AI)

W podejściu code-first API jest efektem ubocznym istniejącego kodu i może ujawniać wewnętrzne szczegóły. W podejściu API-first kontrakt, zwykle zapisany w OpenAPI, jest projektowany i zatwierdzany przed zbudowaniem implementacji lub interfejsu użytkownika.

Dlaczego API-first jest istotne dla agentów AI? (AI)

Epizod "Computer-Using Agents: How CUA Could Transform SaaS" mówi, że stabilne API stanowią kręgosłup inteligentnych systemów i pozwalają łączyć agenty, systemy i przepływy pracy w sposób jasny i przewidywalny. Pojedyncze API za bramą może również obsługiwać klientów agentowych obok klientów webowych i mobilnych.

Słownik

Community wiki

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

Eksperci i firmy w tym temacie

Nikt jeszcze nie wskazał tego tematu. Dodaj go do swojego profilu.

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