Do czego służy usługa Azure API Center?
Centrum interfejsów API platformy Azure to nowa usługa na platformie Azure, która oferuje ustrukturyzowane i scentralizowane repozytorium wszystkich interfejsów API organizacji, umożliwiając ujednolicone śledzenie, odnajdywanie, ponowne używanie i ład. Centrum interfejsów API to bezpieczne rozwiązanie, które konsoliduje i organizuje wszystkie interfejsy API niezależnie od typu, etapu cyklu projektowania lub lokalizacji wdrożenia dla środowiska uruchomieniowego interfejsu API wraz z wszelkimi metadanymi lub informacjami związanymi z interfejsem API.
Zalety centrum interfejsu API
| Problem klienta | Zalety centrum interfejsu API |
|---|---|
| Słaba możliwość odnajdywania i ponownego używania interfejsu API | Łatwość odnajdywania i zużycia interfejsu API. Menedżerowie interfejsów API mogą wyświetlać pełny spis wszystkich interfejsów API w witrynie Azure Portal. Użytkownicy interfejsu API mogą używać internetowego portalu Centrum interfejsów API do odnajdywania i używania interfejsów API lub używania rozszerzenia Centrum interfejsów API dla programu Visual Studio Code do kompilowania, odnajdywania i używania interfejsów API. |
| Interfejsy API w tle, ungoverned | Scentralizowany spis interfejsów API. Centrum interfejsów API umożliwia organizacjom tworzenie centralnego repozytorium interfejsów API z różnych zespołów i działów, które działają jako skonsolidowane źródło prawdy i zaufania dla wszystkich interfejsów API. |
| Potencjalne zagrożenia bezpieczeństwa | Łatwość zapewniania ładu interfejsu API. Dzięki interfejsom API skonsolidowanym w jednej lokalizacji zarządzanie tymi interfejsami API w celu wymuszania zasad zabezpieczeń organizacji staje się łatwiejsze dla zespołów ds. platformy interfejsów API. |
| Niespójny projekt interfejsu API | Zautomatyzowane testy zgodności projektu interfejsu API. Centrum interfejsów API umożliwia administratorom wymuszanie standardów projektowania we wszystkich interfejsach API i implementowanie przepływu pracy linting, który sprawdza interfejsy API względem zdefiniowanego przewodnika po stylu i generuje raport zgodności interfejsu API dostępny w Centrum interfejsów API. |
Role i obowiązki ekosystemu interfejsu API
Ekosystem interfejsu API organizacji często składa się z różnych ról z różnymi obowiązkami, które są integralną częścią jej udanej operacji. Przyjrzyjmy się bliżej niektórym z ról.
Producenci interfejsów API — mogą to być indywidualni deweloperzy lub zespoły, których głównymi obowiązkami są:
- Konsolidowanie specyfikacji i wymagań systemowych
- Projektowanie architektury interfejsu API, która pasuje do zdefiniowanych celów
- Tworzenie, zabezpieczanie i publikowanie interfejsów API
- Testowanie i zapewnianie, że interfejsy API spełniają wymagania funkcjonalne i wydajności
- Dokumentowanie interfejsów API
- Operacje konserwacji interfejsu API, które obejmują zarządzanie wersjami i aktualizacjami
Producenci interfejsów API starają się zapewnić, że przestrzegają najlepszych rozwiązań, zasad zabezpieczeń i zgodności oraz standardów interfejsu API organizacji w celu zapewnienia spójności. Muszą również upewnić się, że nie duplikują nakładu pracy poprzednich/ innych zespołów w organizacji.
Użytkownicy interfejsu API — mogą to być użytkownicy wewnętrzni lub zewnętrzni interfejsów API, którzy:
- Korzystanie z prywatnych interfejsów API w wewnętrznych przepływach pracy i usługach biznesowych (użytkownicy wewnętrzni)
- Używanie ograniczonych punktów końcowych interfejsu API do integracji ze strategicznymi partnerstwami biznesowymi (konsumentami partnerskimi)
- Korzystanie z publicznie dostępnych interfejsów API w celu tworzenia systemów zewnętrznych korzystających z usług udostępnianych przez organizację (odbiorców innych firm)
Użytkownicy interfejsu API muszą upewnić się, że szybko odnajdują najbardziej odpowiednie interfejsy API dla swoich obciążeń, aby uniknąć marnowania cennych zasobów programistycznych i wysiłków na temat duplikacji. Aby to osiągnąć, ważne jest, aby otrzymywać informacje o jakości i łatwym w użyciu dokumentacji w celu zweryfikowania interfejsów API, które zaspokajają ich potrzeby i że mogą bezproblemowo integrować się ze swoimi aplikacjami.
Zespół ds. platformy interfejsu API — inżynierowie platformy API dbają o tworzenie i utrzymywanie skalowalnych, bezpiecznych i wysoce wydajnych architektur interfejsów API dla swojej organizacji. Niektóre z ich zadań mogą obejmować:
- Projektowanie i programowanie architektury interfejsu API
- Ustanawianie i wymuszanie najlepszych rozwiązań interfejsu API i standardów projektowych w całej organizacji
- Wymuszanie monitorowania, analizy i raportowania w celu generowania szczegółowych informacji z możliwością działania
- Implementowanie zabezpieczeń interfejsu API i zarządzanie nimi za pomocą protokołów uwierzytelniania, autoryzacji i szyfrowania
- Ułatwianie współpracy i opinii między menedżerami produktów, producentami interfejsów API i konsumentami w celu dostosowania ich do strategii interfejsu API
- Pomoc dotycząca integracji interfejsu API i rozwiązywania problemów zarówno wewnętrznie, jak i zewnętrznie
Inżynierowie platformy API w firmie Contoso współpracują ze sobą, aby wdrożyć łatwą w wdrożeniu strategię, która uniemożliwi organizacji rozrastanie się interfejsu API.
Jak działa centrum interfejsów API
Inżynierowie platformy interfejsu API w organizacji potrzebują szybkiego i łatwego sposobu konfigurowania scentralizowanego repozytorium wszystkich swoich interfejsów API (zarówno wewnętrznych, jak i zewnętrznych) wraz z innymi metadanymi, takimi jak wersje interfejsu API, definicje i inne. Za pomocą usługi API Center można utworzyć wykaz interfejsów API hostowanych i zarządzanych w różnych rozwiązaniach do zarządzania interfejsami API oraz zarządzać nimi w różnych cyklach życia projektowania, programowania, testowania i produkcji.
Możliwości Centrum interfejsów API platformy Azure
Spis interfejsu API
Podstawą centrum interfejsów API jest utworzenie kompletnego i aktualnego spisu wszystkich interfejsów API utworzonych i używanych w całej organizacji. Ten spis jest kluczem do włączenia ładu, odnajdywania i użycia interfejsu API na dużą skalę.
Centrum interfejsów API umożliwia dodawanie interfejsów API do spisu niezależnie od:
- Technologia i język interfejsu API: ASP.NET Core Web API, Express, FastAPI, bezserwerowy interfejs API itp.
- Typ interfejsu API: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook itp.
- Środowisko uruchomieniowe: klaster Kubernetes, aplikacja internetowa, usługa API Management, apigee API Management, usługa Azure Functions itp.
Nadzór nad interfejsem API
Teraz, wraz z kompletnym spisem interfejsów API, musimy przyjrzeć się temu, jak możemy zapewnić, że te interfejsy API są spójne, ustandaryzowane, użyteczne i bezpieczne. Ład interfejsu API jest definiowany jako praktyka definiowania i stosowania standardów, zasad i procesów na dużą skalę we wszystkich interfejsach API organizacji.
Ta funkcja w usłudze API Center upraszcza śledzenie interfejsów API przy użyciu metadanych, takich jak wersje, właściciele, cykl życia i śledzenie procesów, takich jak przeglądy zgodności, wykrywanie zmian powodujących niezgodność itp.
Centrum interfejsów API oferuje również narzędzia dotyczące ładu projektowego interfejsu API, które obsługuje linting, zaimplementowane przy użyciu linteru Spectral JSON/ YAML, co zapewnia zgodność zarejestrowanych interfejsów API z regułami stylu organizacji i zapewnia funkcje analizy dla interfejsów API. Włączenie tej opcji dla organizacji ułatwia wczesne wykrywanie błędów i niespójności przez wygenerowanie raportu zgodności, który można wyświetlić w Centrum interfejsów API.
Działania platformy interfejsu API są najbardziej skuteczne, gdy mają zakup dla deweloperów. Rozszerzenie Centrum interfejsu API dla programu Visual Studio Code zapewnia funkcje zapewniania ładu interfejsu API w lewo na potrzeby wykrywania zmian powodujących niezgodność i ładu projektowania interfejsu API w celu zapewnienia, że interfejsy API są tworzone w odpowiedni sposób po raz pierwszy.
Odnajdywanie i użycie interfejsu API
Centrum interfejsów API usprawnia cały cykl projektowania interfejsu API, poprawiając środowisko deweloperskie dzięki integracji z popularnymi narzędziami deweloperskich, takimi jak Visual Studio Code. Rozszerzenie Centrum interfejsu API zapewnia użytkownikom interfejsu API możliwość odnajdywania, wypróbowania i korzystania z interfejsów API bezpośrednio w programie Visual Studio Code w kontekście sposobu, w jaki już działają. Inną możliwością centrum interfejsu API jest tradycyjny internetowy portal Centrum interfejsów API, który umożliwia użytkownikom interfejsu API łatwe nawigowanie po dokumentacji, odnajdywanie, uzyskiwanie dostępu i korzystanie z interfejsów API z katalogu interfejsów API.
W następnej lekcji dowiesz się, jak utworzyć spis interfejsu API i zarządzać nim za pomocą centrum interfejsu API za pośrednictwem witryny Azure Portal, lokalnie przy użyciu interfejsu wiersza polecenia platformy Azure lub programu VS Code przy użyciu rozszerzenia Centrum interfejsu API.