Anti-Muster: Management API-Aufrufe von einem API-Proxy aus aufrufen

Sie lesen gerade die Apigee Edge -Dokumentation.
Zur Apigee X -Dokumentation. info

Edge bietet ein leistungsstarkes Dienstprogramm namens „Management APIs“, das Folgendes anbietet:

  • API-Proxys bereitstellen oder Bereitstellung aufheben
  • Virtuelle Hosts, Schlüsselspeicher und Truststores konfigurieren
  • Entitäten wie KeyValueMaps, API-Produkte, Entwickler Apps, Entwickler, Consumer-Schlüssel usw. erstellen, löschen und/oder aktualisieren
  • Informationen zu diesen Entitäten abrufen

Diese Dienste werden über eine Komponente namens Management Server in der Apigee Edge-Plattform zugänglich gemacht. Diese Dienste lassen sich mit einfachen Management API-Aufrufen einfach aufrufen.

Manchmal müssen wir einen oder mehrere dieser Dienste von API-Proxys zur Laufzeit verwenden. Dies liegt daran, dass die Entitäten wie KeyValueMaps, OAuth-Zugriffstokens, API-Produkte, Entwickler-Apps, Entwickler, Consumer-Schlüssel usw. nützliche Informationen in Form von Schlüssel/Wert-Paaren, benutzerdefinierten Attributen oder als Teil des Profils enthalten.

Sie können beispielsweise die folgenden Informationen in KeyValueMap speichern, um sie zur Laufzeit sicherer und zugänglicher zu machen:

  • Backend-Ziel-URLs
  • Umgebungsattribute
  • Sicherheitsanmeldedaten für Backend- oder Drittanbietersysteme

Möglicherweise möchten Sie auch die Liste der API-Produkte oder die E-Mail-Adresse des Entwicklers zur Laufzeit abrufen. Diese Informationen werden im Rahmen des Developer Apps-Profils verfügbar sein.

Alle diese Informationen können zur Laufzeit effektiv verwendet werden, um dynamisches Verhalten in Richtlinien oder benutzerdefiniertem Code in Apigee Edge zu aktivieren.

Anti-Pattern

Die Management APIs werden bevorzugt und sind nützlich für Verwaltungsaufgaben und sollten nicht für die Ausführung von Laufzeitlogik in API-Proxy-Flows verwendet werden. Das hat folgende Gründe:

  • Die Verwendung von Management APIs für den Zugriff auf Informationen zu Entitäten wie KeyValueMaps, OAuth Zugriffstokens oder zu einem anderen Zweck über API-Proxys führt zu einer Abhängigkeit von Management Servern.
  • Verwaltungsserver sind kein Bestandteil der Edge-Laufzeitkomponente und daher sind sie möglicherweise nicht hochverfügbar.
  • Verwaltungsserver können auch nicht innerhalb desselben Netzwerks oder Rechenzentrums bereitgestellt werden und können daher zur Laufzeit zu Netzwerklatenzen führen.
  • Die Einträge auf den Verwaltungsservern werden für einen längeren Zeitraum im Cache gespeichert. Daher können wir die neuesten Daten möglicherweise nicht sofort in den API-Proxies anzeigen, wenn wir innerhalb kurzer Zeit Schreibvorgänge und Lesevorgänge ausführen.
  • Erhöhen der Netzwerk-Hops zur Laufzeit

Im folgenden Codebeispiel wird der Management API-Aufruf über den benutzerdefinierten JavaScript-Code durchgeführt, um die Informationen aus der KeyValueMap abzurufen:

var response = httpClient.send('https://api.enterprise.apigee.com/v1/o/org_name/e/env_name/keyvaluemaps/kvm_name')

Wenn der Verwaltungsserver nicht verfügbar ist, schlägt der JavaScript-Code fehl, der den Management API-Aufruf aufruft. Dadurch schlägt die API-Anfrage fehl.

Auswirkungen

  • Führt während der Laufzeit zu einer zusätzlichen Abhängigkeit von Verwaltungsservern. Jeder Fehler auf den Verwaltungsservern wirkt sich auf die API-Aufrufe aus.
  • Nutzeranmeldedaten für Management APIs müssen entweder lokal oder in einem sicheren Speicher wie z. B. einer verschlüsselten KVM gespeichert werden.
  • Leistungseinbußen durch den Aufruf des Verwaltungsdienstes über das Netzwerk
  • Die aktualisierten Werte werden aufgrund einer längeren Cache-Ablaufzeit auf Verwaltungsservern möglicherweise nicht sofort angezeigt.

Best Practice

Es gibt effektivere Möglichkeiten, Informationen von Entitäten wie KeyValueMaps, API-Produkten, Entwickler-Apps, Entwicklern, Consumer-Schlüsseln usw. zur Laufzeit abzurufen. Hier einige Beispiele:

  • Verwenden Sie eine KeyValueMapOperations-Richtlinie, um auf Informationen aus KeyValueMaps zuzugreifen. Der folgende Beispielcode zeigt, wie Informationen aus der KeyValueMap abgerufen werden: 
    <!-- /antipatterns/examples/2-6.xml -->
<KeyValueMapOperations mapIdentifier="urlMap" async="false"
    continueOnError="false" enabled="true" name="GetURLKVM">
  <DisplayName>GetURLKVM</DisplayName>
  <ExpiryTimeInSecs>86400</ExpiryTimeInSecs>
  <Scope>environment</Scope>
  <Get assignTo="urlHosti" index="2">
    <Key>
      <Parameter>urlHost_1</Parameter>
    </Key>
  </Get>
</KeyValueMapOperations>
  • Um auf API-Produkte, Entwickler-Apps, Entwickler, Consumer-Schlüssel usw. im API-Proxy zuzugreifen, haben Sie folgende Möglichkeiten:
    • Wenn Ihr API-Proxy-Flow eine VerifyAPIKey-Richtlinie hat, können Sie auf die Informationen zugreifen mit den Flow-Variablen, die als Teil dieser Richtlinie ausgefüllt werden. Im folgenden Beispielcode sehen Sie, wie Sie den Namen und die created_by-Informationen einer Entwickler-App mit JavaScript abrufen: 
      <!-- /antipatterns/examples/2-7.xml -->
print("Application Name ", context.getVariable(""verifyapikey. VerifyAPIKey.app.name"));
print("Created by:", context.getVariable("verifyapikey. VerifyAPIKey.app.created_by"));
    • Wenn Ihr API-Proxy-Flow keine VerifyAPIKey-Richtlinie hat, können Sie mithilfe der Richtlinien „Access Entity“ und „Extract Variables“ auf die Profile von API-Produkten, Entwickler-Apps usw. zugreifen:
      1. Rufen Sie das Profil der Entwickler-App mit der AccessEntity-Richtlinie ab: 
        <!-- /antipatterns/examples/2-8.xml -->
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessEntity async="false" continueOnError="false" enabled="true" name="GetDeveloperApp">
  <DisplayName>GetDeveloperApp</DisplayName>
  <EntityType value="app"></EntityType>
  <EntityIdentifier ref="developer.app.name" type="appname"/>
  <SecondaryIdentifier ref="developer.id" type="developerid"/>
</AccessEntity>
      2. Extrahieren Sie die appId aus der Entwickler-App mit der ExtractVariables-Richtlinie: 
        <!-- /antipatterns/examples/2-9.xml -->
<ExtractVariables name="Extract-Developer App-Info">
  <!--
    The source element points to the variable populated by AccessEntity policy.
    The format is <policy-type>.<policy-name>
    In this case, the variable contains the whole developer profile.
  -->
  <Source>AccessEntity.GetDeveloperApp"</Source>
  <VariablePrefix>developerapp</VariablePrefix>
  <XMLPayload>
    <Variable name="appld" type="string">
      <!-- You parse elements from the developer profile using XPath. -->
      <XPath>/App/AppId</XPath>
    </Variable>
  </XMLPayload>
</ExtractVariables>

Weitere Informationen