Verweisen Sie auf OpenAPI Spezifikation externe Datei mit Infrastructure Composer - AWS-Infrastruktur-Composer

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verweisen Sie auf OpenAPI Spezifikation externe Datei mit Infrastructure Composer

In diesem Beispiel wird Infrastructure Composer von der Konsole aus verwendet, um auf ein externes Objekt zu verweisen OpenAPI Spezifikationsdatei, die ein API Gateway definiert REST API.

Erstellen Sie zunächst auf der Infrastructure Composer-Startseite ein neues Projekt.

Aktivieren Sie anschließend die lokale Synchronisierung, indem Sie im Menü die Option Lokale Synchronisierung aktivieren auswählen. Erstellen Sie einen neuen Ordner mit dem Namendemo, warten Sie auf die Aufforderung, Dateien anzuzeigen, und wählen Sie Aktivieren. Wenn Sie dazu aufgefordert werden, wählen Sie Änderungen speichern aus.

Das Fenster Infrastructure Composer Activate Local Sync mit einem ausgewählten Demo-Projektordner und der Schaltfläche Aktivieren steht zur Auswahl bereit.

Ziehen Sie als Nächstes eine Amazon API Gateway-Karte auf die Leinwand. Wählen Sie Details aus, um den Bereich mit den Ressourceneigenschaften aufzurufen.

Eine API Gateway-Ressource auf der Arbeitsfläche, bei der der Bereich mit den Ressourceneigenschaften geöffnet ist.

Konfigurieren Sie im Bereich mit den Ressourceneigenschaften Folgendes und speichern Sie es.

  • Wählen Sie die Option Externe Datei für API-Definition verwenden.

  • Eingabe ./api-spec.yaml als relativer Pfad zur externen Datei

Ein Fenster mit dem Kontrollkästchen „Externe Datei für API-Definition verwenden“ und einem relativen Pfad zu einer definierten externen Datei.

Dadurch wird das folgende Verzeichnis auf unserem lokalen Computer erstellt:

demo
└── api-spec.yaml

Jetzt können Sie die externe Datei auf unserem lokalen Computer konfigurieren. Öffnen Sie mit unserer den OrdnerIDE, der api-spec.yaml sich in Ihrem Projekt befindet. Ersetzen Sie den Inhalt durch Folgendes:

openapi: '3.0'
info: {}
paths:
  /:
    get:
      responses: {}
    post:
      x-amazon-apigateway-integration:
        credentials:
          Fn::GetAtt:
            - ApiQueuesendmessageRole
            - Arn
        httpMethod: POST
        type: aws
        uri:
          Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:sqs:path/${AWS::AccountId}/${Queue.QueueName}
        requestParameters:
          integration.request.header.Content-Type: '''application/x-www-form-urlencoded'''
        requestTemplates:
          application/json: Action=SendMessage&MessageBody={"data":$input.body}
        responses:
          default:
            statusCode: 200
      responses:
        '200':
          description: 200 response

In der Infrastructure Composer-Vorlagenansicht können Sie sehen, dass Infrastructure Composer Ihre Vorlage automatisch aktualisiert hat, sodass sie auf die externe Datei verweist.

Die Infrastructure Composer-Vorlagenansicht zeigt Ihren Infrastrukturcode, der so konfiguriert ist, dass er auf die externe Datei verweist.