Wat is Azure API Center?
Azure API Center is een nieuwe service in Azure die een gestructureerde en gecentraliseerde opslagplaats biedt van al uw organisatie-API's, waardoor geïntegreerde tracering, detectie, hergebruik en governance mogelijk is. API Center is een veilige oplossing waarmee al uw API's worden samengevoegd en ingedeeld, ongeacht hun type, ontwikkelingslevenscyclusfase of implementatielocatie voor uw API-runtime, samen met metagegevens of API-gerelateerde informatie.
Voordelen van API Center
| Klantprobleem | Voordelen van API Center |
|---|---|
| Slechte API-detectie en hergebruik | Gebruiksgemak van API-detectie en -verbruik. API-managers kunnen een volledige inventarisatie van alle API's in Azure Portal bekijken. API-gebruikers kunnen de webgebaseerde API Center-portal gebruiken om API's te detecteren en te gebruiken, of de API Center-extensie voor Visual Studio Code gebruiken om API's te bouwen, te detecteren en te gebruiken. |
| Schaduw, geforceerd API's | Gecentraliseerde inventarisatie van API's. Met API Center kunnen organisaties een centrale opslagplaats van API's bouwen van verschillende teams en afdelingen die fungeren als een geconsolideerde bron van waarheid en vertrouwen voor alle API's. |
| Mogelijke beveiligingsrisico's | Eenvoudig API-beheer. Met API's die op één locatie zijn geconsolideerd, wordt het beheren van deze API's voor het afdwingen van beveiligingsbeleid voor organisaties eenvoudiger voor API Platform-teams. |
| Inconsistent API-ontwerp | Controles van de geautomatiseerde API-ontwerpconformance. Met API Center kunnen beheerders ontwerpstandaarden afdwingen voor alle API's en een lintingwerkstroom implementeren die API's controleert op basis van een gedefinieerde stijlhandleiding en een API-nalevingsrapport genereert dat toegankelijk is in uw API Center. |
Rollen en verantwoordelijkheden van HET API-ecosysteem
Het API-ecosysteem van een organisatie bestaat vaak uit verschillende rollen met diverse verantwoordelijkheden die integraal zijn voor de succesvolle werking. Laten we eens kijken naar een aantal rollen.
API-producenten : dit kunnen afzonderlijke ontwikkelaars of teams zijn waarvan de belangrijkste verantwoordelijkheden zijn:
- Systeemspecificaties en -vereisten consolideren
- De API-architectuur ontwerpen die past bij de gedefinieerde doelen
- De API's ontwikkelen, beveiligen en publiceren
- Api's testen en controleren op zowel functionele als prestatievereisten
- De API's documenteren
- API-onderhoudsbewerkingen, waaronder het beheren van versies en updates
API-producenten streven ernaar om ervoor te zorgen dat ze de best practices, het beveiligings- en nalevingsbeleid en de API-standaarden van de organisatie volgen voor consistentie. Ze moeten er ook voor zorgen dat ze de inspanningen van eerdere/ andere teams binnen de organisatie niet dupliceren.
API-gebruikers : dit kunnen interne of externe gebruikers van de API's zijn die:
- Privé-API's gebruiken in hun interne zakelijke werkstromen en -services (interne consumenten)
- Beperkte API-eindpunten gebruiken om te integreren in strategische zakelijke partnerschappen (partnerconsumenten)
- Openbaar beschikbare API's gebruiken om externe systemen te bouwen die gebruikmaken van services die door de organisatie worden geleverd (consumenten van derden)
API-consumenten moeten ervoor zorgen dat ze snel de meest geschikte API's voor hun workloads ontdekken om waardevolle ontwikkelingsresources en inspanningen op duplicatie te voorkomen. Om dit te bereiken, is het belangrijk dat ze documentatie van kwaliteit en gebruiksvriendelijk ontvangen om de API's te valideren die hun respectieve behoeften oplossen en dat ze naadloos kunnen integreren in hun toepassingen.
API Platform-team : API Platform-technici zijn belangrijk voor het maken en onderhouden van schaalbare, veilige en zeer presterende API-architecturen voor hun organisatie. Enkele van hun taken kunnen zijn:
- Ontwerp en ontwikkeling van API-architectuur
- Best practices en ontwerpstandaarden voor API's in de hele organisatie vaststellen en afdwingen
- Bewaking, analyse en rapportage afdwingen om bruikbare inzichten te genereren
- API-beveiliging implementeren en beheren via verificatie-, autorisatie- en versleutelingsprotocollen
- Vergemakkelijken van samenwerking en feedback tussen productmanagers, API-producenten en consumenten om zich af te stemmen op API-strategieën
- Hulp bij api-integratie en probleemoplossing zowel intern als extern
API Platform-engineers bij Contoso werken samen om een eenvoudig te implementeren strategie uit te voeren die voorkomt dat de organisatie api-sprawl ondervindt.
Hoe API Center werkt
API Platform-engineers in een organisatie hebben een snelle en eenvoudige manier nodig om een gecentraliseerde opslagplaats van al hun API's (zowel intern als extern) te configureren, samen met andere metagegevens, zoals API-versies, definities en meer. Met API Center kunt u een catalogus maken met API's die worden gehost en beheerd op verschillende API-beheeroplossingen en deze beheren in hun verschillende ontwerp-, ontwikkelings-, test- en productielevenscycli.
Mogelijkheden van Azure API Center
API-inventaris
Bij de basis van API Center wordt een volledige en actuele inventarisatie gemaakt van alle API's die in de hele organisatie zijn gebouwd en gebruikt. Deze inventaris is essentieel voor het inschakelen van API-governance, detectie en verbruik op schaal.
Met API Center kunt u API's toevoegen aan uw inventaris, ongeacht:
- API-technologie en taal: ASP.NET Core Web-API, Express, FastAPI, serverloze API, enzovoort.
- API-type: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook, enzovoort.
- Runtime-omgeving: Kubernetes-cluster, Web App, API Management, Apigee API Management, Azure Functions, enzovoort.
API-governance
Nu, met een volledige API-inventaris, moeten we kijken hoe we ervoor kunnen zorgen dat deze API's consistent, gestandaardiseerd, bruikbaar en veilig zijn. API-governance wordt gedefinieerd als de praktijk voor het definiëren en toepassen van standaarden, beleidsregels en processen op schaal in alle organisatie-API's.
Deze mogelijkheid in API Center vereenvoudigt het bijhouden van API's met behulp van metagegevens zoals versies, eigenaren, levenscyclus en het bijhouden van processen zoals nalevingsbeoordelingen, wijzigingsdetectie, enzovoort.
API Center biedt ook hulpprogramma's voor API-ontwerpgovernance die linting ondersteunt, geïmplementeerd met behulp van de Spectral JSON/YAML-linter, die ervoor zorgt dat geregistreerde API's voldoen aan de stijlregels van de organisatie en een analysefunctionaliteit biedt voor uw API's. Als u dit inschakelt voor uw organisatie, kunt u snel fouten en inconsistentie detecteren door een nalevingsrapport te genereren dat kan worden weergegeven in uw API Center.
Api Platform-inspanningen zijn het meest succesvol wanneer ze ontwikkelaars kopen. De API Center-extensie voor Visual Studio Code biedt mogelijkheden voor api-governance met shift-links voor wijzigingsdetectie en API-ontwerpgovernance om ervoor te zorgen dat API's de eerste keer op de juiste manier worden gebouwd.
API-detectie en -verbruik
API Center stroomlijnt de volledige levenscyclus van API-ontwikkeling, waardoor de ontwikkelaarservaring wordt verbeterd door integratie met populaire ontwikkelhulpprogramma's zoals Visual Studio Code. De API Center-extensie biedt een ervaring voor API-gebruikers om API's rechtstreeks in Visual Studio Code te detecteren, proberen en gebruiken in de context van hoe ze al werken. Een andere mogelijkheid van API Center is een traditionele webgebaseerde API Center-portal, ontworpen om API-consumenten in staat te stellen eenvoudig te navigeren in documentatie, API's te detecteren, te openen en te gebruiken vanuit uw API-catalogus.
In de volgende les ziet u hoe u uw API-inventaris kunt maken en beheren met API Center via Azure Portal, lokaal met behulp van azure CLI of VS Code met behulp van de API Center-extensie.