fb
API Management 3 min

Aangepaste API-eigenschappen voor beter API-beheer

Dinusha
api management
Scroll

API’s zijn een essentieel technisch aspect om de waarden van de bedrijven en het digitale transformatietraject te verbeteren. De WSO2 API Manager is een alles-in-één API-beheerproduct dat helpt bij het beheren van de volledige API-levenscyclus van een API met een brede reeks functies.

Met de API’s kunnen bedrijven hun mogelijkheden uitbreiden naar geïnteresseerde partijen. Met de uitbreiding en groei van een bedrijf kan het aantal beschikbare API’s snel groeien met een toenemend aantal gebruiksscenario’s waarnaar vraag is vanuit het bedrijf. Omdat API’s een sleutelrol spelen in het digitale transformatietraject, is goed API-beheer en -management van cruciaal belang om de API’s optimaal te benutten

API’s bestaan uit een set vooraf gedefinieerde standaardeigenschappen, zoals API-naam, versie en context, die nuttig kunnen zijn om de kenmerken van de API’s te identificeren. Naast deze eigenschappen kunnen de API-makers en -uitgevers extra ‘key-value pairs’ aan de API’s toevoegen. Deze aanvullende eigenschappen worden ‘Aangepaste API-eigenschappen’ genoemd.

Dit artikel bevat een basisoverzicht van Aangepaste API-eigenschappen en hoe deze functie helpt bij het verbeteren van API-beheer en -management.

De API-eigenschappen zijn een key-value pair. Maar ze moeten de volgende kenmerken bevatten;

  • Uniek
  • Geen spaties
  • Hoofdlettergevoelig
  • Gebaseerd op niet-gereserveerde zoekwoorden

Waarom zijn de Aangepaste API-eigenschappen belangrijk?

  • De doorzoekbaarheid van de API’s is verbeterd
  • Aangepaste API-eigenschappen kunnen selectief worden weergegeven in de ontwikkelaarsportal
  • Mogelijkheid om API-beheerbeleid van een API te wijzigen op basis van aangepaste eigenschappen

API-eigenschappen kunnen op de volgende twee manieren aan een API worden toegevoegd:

  • Met behulp van de gebruikersinterface van de API Manager-uitgeversportal, meer informatie over de WSO2-documenten .()
  • Met behulp van de REST API’s van het API Manager-uitgeversproduct, meer informatie over de WSO2-documenten .

Beter zoeken in API’s

Als je meerdere API’s hebt, moet je deze snel kunnen filteren of doorzoeken in de ontwikkelaarsportal of de uitgeversportal. Met een toenemend aantal API’s in je bedrijf kan het echter moeilijk zijn om een API of een reeks API’s te identificeren. Aangepaste API-eigenschappen helpen je een betere zoekervaring te realiseren.

Je kunt het key-value pair van de API-eigenschap eenvoudig invoeren in de zoekbalk en dan worden alleen de API’s weergeven die bij de betreffende API-eigenschappen horen, wat resulteert in een betere gebruikerservaring en beter API-beheer.

api manager yenlo

Gezocht op authentication:flow1

api manager

Gezocht op authentication:flow2

API-eigenschappen selectief weergeven in ontwikkelaarsportal

Met de optie om aangepaste API-eigenschappen weer te geven in de ontwikkelaarsportal, kunnen je API-makers en -uitgevers de API-consumenten alleen een vooraf gedefinieerde set eigenschappen laten zien. Zoals te zien is in de onderstaande afbeelding, kun je ervoor kiezen om de API-eigenschap in de ontwikkelaarsportal weer te geven door simpelweg op het selectievakje ‘Weergeven in devportal’ te klikken.

api manager blog2

Als de aangepaste eigenschappen van de API’s zijn ingesteld om zichtbaar te zijn in de ontwikkelaarsportal, kun je zoeken naar API’s op basis van die eigenschappen, zoals in de uitgeversportal.

api manager blog
api manager

API-beheerbeleid wijzigen

WSO2 API Manager past API-beheerbeleid toe met behulp van het ‘handlers-concept’, waarbij elk van de API-beleidsregels, zoals authenticatiebeperking, een eigen handler heeft. Als er een aanpassing moet worden gedaan, kan er een aangepaste handler worden geschreven en geconfigureerd om toe te passen op de API’s.

Logica voor het inschakelen van handlers kan zodanig worden aangepast dat de specifieke handlers beschikbaar zijn voor API’s op basis van hun aangepaste eigenschappen.

Als je bijvoorbeeld twee omgevingen hebt met twee verschillende aangepaste authenticatieflows, kun je eenvoudig Aangepaste API-eigenschappen gebruiken om de relevante omgevingsspecifieke aangepaste authenticatiehandler voor een API in te schakelen.

Conclusie

Aangepaste API-eigenschappen zijn unieke key-value pairs die bij een API horen, wat een voordeel biedt bij API-beheer.

Ze kunnen worden toegevoegd aan een API met behulp van zowel de REST API van de WSO2 API Manager-uitgever als de gebruikersinterface van de uitgeversportal. Hoewel de Aangepaste API-eigenschappen helpen om de gebruikerservaring van API-zoekopdrachten voor zowel uitgever als consumenten te verbeteren, kunnen ze ook selectief aan de consumenten worden getoond. Bovendien kan API-beheerbeleid selectief worden toegepast op API’s met behulp van Aangepaste API-eigenschappen.

API-beheer en -management is een belangrijke factor in het digitale transformatietraject. Neem contact op met ons getalenteerde team van experts bij Yenlo om meer te weten te komen over de mogelijkheden en om kennis te nemen van het digitale transformatietraject.