Kurzanleitung zum Hinzufügen einer API

Deployment Manager bietet die Möglichkeit, eine Drittanbieter-API mit dem Deployment Manager-Dienst zu registrieren. Nach der Registrierung einer API als Typanbieter in Deployment Manager können Sie Deployment Manager dazu verwenden, Ressourcen aus der API als Typen in Ihrer Konfiguration bereitzustellen.

Dieses Dokument ist eine kurze Anleitung, die den Prozess der Integration einer Drittanbieter-API mit Deployment Manager beschreibt. Diese Seite enthält keine ausführlichen Schritt-für-Schritt-Anleitungen zu diesem Prozess, sondern bietet einen Überblick und zusätzliche Links für weitere Informationen. Auf dieser Seite erhalten Sie eine detaillierte Übersicht zum Hinzufügen einer API. Schritt-für-Schritt-Anleitungen finden Sie in der umfangreichen Dokumentation.

Anforderungen für Integration einer API mit Deployment Manager

Deployment Manager hat bestimmte Erwartungen an eine API, die integriert werden soll. Dazu gehören:

  • Deployment Manager erwartet eine RESTful API. Das heißt, die API stellt eine REST-ähnliche Schnittstelle mit CRUD-Methoden (Erstellen, Lesen, Aktualisieren, Löschen) bereit.
  • Alle Pfad- und Abfrageparameter lassen sich erfolgreich auflösen. Die Pfad- und Abfrageparameter der API müssen als Teil des Ressourcentextes oder in allen API-Methoden vorhanden sein, damit Deployment Manager den Parameter zuordnen kann, wenn ein Benutzer ihn angibt.
  • Der Endpunkt des API-Deskriptordokuments muss zugänglich sein. Deployment Manager führt eine HTTP-Anfrage aus, um das Deskriptordokument einer API abzurufen. Dies bedeutet, dass das Dokument an einem Ort gehostet sein muss, auf den Deployment Manager zugreifen kann. Das Dokument muss öffentlich zugänglich oder durch eine Basisauthentifizierung geschützt sein.
  • Die API kann entweder eine Basisauthentifizierung verwenden oder die Authentifizierung mit OAuth 2.0 unterstützen. Letzteres ist der Fall, wenn die API auf Google Kubernetes Engine oder Google Cloud Endpoints ausgeführt wird. Es wird dann ein Zugriffstoken vom Dienstkonto des Projekts für die Authentifizierung verwendet. Weitere Informationen finden Sie unter Authentifizierung.
  • Wenn Ihre API komplex ist, müssen Sie möglicherweise zusätzliche Optionen konfigurieren und ein weniger offensichtliches API-Verhalten gegenüber Deployment Manager klarstellen.

Weitere Informationen finden Sie unter API-Anforderungen.

API zu Deployment Manager hinzufügen

Nachdem sichergestellt ist, dass Ihre API den obigen Anforderungen entspricht, fügen Sie die API als Typanbieter hinzu. Sie müssen ein API-Deskriptordokument und optional zusätzliche API-Optionen mit erweiterten Optionen liefern. Wenn Sie eine API als Typanbieter hinzufügen, werden alle Ressourcen dieser API im Deployment Manager zur Verfügung gestellt. Nutzer können diese Ressourcen nun mit Deployment Manager erstellen, aktualisieren oder löschen.

Wenn Ihre API heikle API-Muster verwendet, die nicht einfach erkennbar sind, müssen Sie eventuell Eingabezuordnungen für Deployment Manager zur Verfügung stellen, damit die API-Anfragen korrekt verarbeitet werden können. Weitere Informationen finden Sie unter Erweiterte API-Optionen.

Typanbieter in Konfigurationsdateien aufrufen

Sobald eine API in Deployment Manager registriert ist, können Sie API-Ressourcen erstellen, indem Sie die API-Ressource als einen Typ in Ihrer Konfiguration aufrufen.

Beispiel: Wenn Sie Ihren Typanbieter example-directory-api genannt haben und eine API-Ressource namens person erstellen möchten, können Sie den Typ in Ihren Konfigurationen so angeben:

resources:
- name: Jane
  type: my-project/example-directory-api:person
  properties:
  - name: Jane
    website: www.example.com
    ...

Zum Vergleich: Dies ist derselbe Vorgang wie das Aufrufen einer Google API und das Erstellen einer API-Ressource:

resource:
- name: example-instance
  type: compute.v1.instance
  properties:
  - machineType: n1-standard-1
    ...

Weitere Informationen

Hat Ihnen diese Seite weitergeholfen? Teilen Sie uns Ihr Feedback mit:

Feedback geben zu...

Cloud Deployment Manager-Dokumentation