

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.

# Entwickeln APIs Sie REST mit OpenAPI in API Gateway
<a name="api-gateway-import-api"></a>

Sie können API Gateway verwenden, um eine REST-API aus einer externen Definitionsdatei in API Gateway zu importieren. Gegenwärtig unterstützt API Gateway die Definitionsdateien [OpenAPI v2.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) und [OpenAPI v3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.1.md), wobei Ausnahmen in [Amazon API Gateway — wichtige Hinweise für REST APIs](api-gateway-known-issues.md#api-gateway-known-issues-rest-apis) aufgeführt werden. Sie können eine API aktualisieren, indem Sie diese mit einer neuen Definition überschreiben, oder Sie können eine Definition mit einer vorhandenen API zusammenführen. Die Optionen in der Anforderungs-URL geben Sie mithilfe eines `mode`-Abfrageparameters an. 

Eine Anleitung zur Verwendung der "Import API (API importieren)"-Funktion über die API Gateway-Konsole finden Sie unter [Tutorial: Erstellen einer REST-API durch Importieren eines Beispiels](api-gateway-create-api-from-example.md).

**Topics**
+ [Edge-optimierte API in API Gateway importieren](import-edge-optimized-api.md)
+ [Regionale API in API Gateway importieren](import-export-api-endpoints.md)
+ [Importieren einer OpenAPI-Datei zum Aktualisieren einer vorhandenen API-Definition](api-gateway-import-api-update.md)
+ [Die `basePath`-Eigenschaft von OpenAPI einrichten](api-gateway-import-api-basePath.md)
+ [AWS Variablen für den OpenAPI-Import](import-api-aws-variables.md)
+ [Fehler und Warnungen beim Import Ihrer API in API Gateway](api-gateway-import-api-errors-warnings.md)
+ [REST-API von API Gateway importieren](api-gateway-export-api.md)

# Edge-optimierte API in API Gateway importieren
<a name="import-edge-optimized-api"></a>

Geben Sie neben der OpenAPI-Datei für den Importvorgang den Endpunkttyp `EDGE` als zusätzliche Eingabe an, um eine API-OpenAPI-Datei zum Erstellen einer neuen Edge-optimierten API zu importieren. Sie können dies mit der API Gateway Gateway-Konsole oder einem AWS SDK tun. AWS CLI

Eine Anleitung zur Verwendung der "Import API (API importieren)"-Funktion über die API Gateway-Konsole finden Sie unter [Tutorial: Erstellen einer REST-API durch Importieren eines Beispiels](api-gateway-create-api-from-example.md).

**Topics**
+ [Edge-optimierte API über die API Gateway-Konsole importieren](#import-edge-optimized-api-with-console)
+ [Importieren Sie eine Edge-optimierte API mit dem AWS CLI](#import-edge-optimized-api-with-awscli)

## Edge-optimierte API über die API Gateway-Konsole importieren
<a name="import-edge-optimized-api-with-console"></a>

Gehen Sie wie folgt vor, um eine Edge-optimierte API mit der API-Gateway-Konsole zu importieren:

1. Melden Sie sich bei der API Gateway Gateway-Konsole unter [https://console.aws.amazon.com/apigatewayan](https://console.aws.amazon.com/apigateway).

1. Wählen Sie **Create API (API erstellen)** aus.

1. Unter **REST-API**, wählen Sie **Import** (Importieren) aus.

1.  Kopieren Sie die OpenAPI-Definition einer API und fügen Sie sie in den Code-Editor ein, oder klicken Sie auf **Choose file** (Datei auswählen), um eine OpenAPI-Datei von einem lokalen Laufwerk zu laden.

1.  Wählen Sie für **API-Endpunkt-Typ** die Option **Edge-optimiert** aus.

1.  Wählen Sie **Create API** (API erstellen) aus, um die OpenAPI-Definitionen zu importieren.

## Importieren Sie eine Edge-optimierte API mit dem AWS CLI
<a name="import-edge-optimized-api-with-awscli"></a>

Der folgende [import-rest-api](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html)Befehl importiert eine API aus einer OpenAPI-Definitionsdatei, um eine neue Edge-optimierte API zu erstellen:

```
aws apigateway import-rest-api \
    --fail-on-warnings \
    --body 'file://path/to/API_OpenAPI_template.json'
```

Oder geben Sie für den Abfragezeichenfolgenparameter `endpointConfigurationTypes` ausdrücklich `EDGE` an: 

```
aws apigateway import-rest-api \
    --parameters endpointConfigurationTypes=EDGE \
    --fail-on-warnings \
    --body 'file://path/to/API_OpenAPI_template.json'
```



# Regionale API in API Gateway importieren
<a name="import-export-api-endpoints"></a>

Beim Importieren einer API können Sie die regionale Endpunktkonfiguration für die API auswählen. Sie können die API Gateway Gateway-Konsole AWS CLI, das oder ein AWS SDK verwenden.

Die API-Endpunktkonfiguration ist beim Exportieren einer API nicht in den exportierten API-Definitionen enthalten.

Eine Anleitung zur Verwendung der "Import API (API importieren)"-Funktion über die API Gateway-Konsole finden Sie unter [Tutorial: Erstellen einer REST-API durch Importieren eines Beispiels](api-gateway-create-api-from-example.md).

**Topics**
+ [Regionale API über die API Gateway-Konsole importieren](#import-regional-api-with-console)
+ [Importieren Sie eine regionale API mit dem AWS CLI](#import-regional-api-with-awscli)

## Regionale API über die API Gateway-Konsole importieren
<a name="import-regional-api-with-console"></a>

Gehen Sie wie folgt vor, um eine API eines regionalen Endpunkts über die API Gateway-Konsole zu importieren:

1. Melden Sie sich bei der API Gateway Gateway-Konsole unter [https://console.aws.amazon.com/apigatewayan](https://console.aws.amazon.com/apigateway).

1. Wählen Sie **Create API (API erstellen)** aus.

1. Unter **REST-API**, wählen Sie **Import** (Importieren) aus.

1.  Kopieren Sie die OpenAPI-Definition einer API und fügen Sie sie in den Code-Editor ein, oder klicken Sie auf **Choose file** (Datei auswählen), um eine OpenAPI-Datei von einem lokalen Laufwerk zu laden.

1. Wählen Sie für **API-Endpunkttyp** die Option **Regional** aus.

1.  Wählen Sie **Create API** (API erstellen) aus, um die OpenAPI-Definitionen zu importieren.

## Importieren Sie eine regionale API mit dem AWS CLI
<a name="import-regional-api-with-awscli"></a>

Der folgende [import-rest-api](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html)Befehl importiert eine OpenAPI-Definitionsdatei und setzt den Endpunkttyp auf Regional:

```
aws apigateway import-rest-api \
    --parameters endpointConfigurationTypes=REGIONAL \
    --fail-on-warnings \
    --body 'file://path/to/API_OpenAPI_template.json'
```

# Importieren einer OpenAPI-Datei zum Aktualisieren einer vorhandenen API-Definition
<a name="api-gateway-import-api-update"></a>

 Sie können nur API-Definitionen importieren, um eine vorhandene API zu aktualisieren, ohne die Endpunkt-Konfiguration sowie Phasen und Phasen-Variablen oder Referenzen zu API-Schlüsseln zu verändern. 

 Der import-to-update Vorgang kann in zwei Modi ausgeführt werden: Zusammenführen oder Überschreiben. 

Wenn eine API (`A`) mit einer anderen (`B`) zusammengeführt wird, behält die resultierende API die Definitionen beider `A` bei, `B` sofern die beiden APIs keine widersprüchlichen Definitionen haben. Wenn Konflikte auftreten, überschreiben die Methodendefinitionen der zusammenführenden API (`A`) die entsprechenden Methodendefinitionen der zusammengeführten API (`B`). Beispiel: `B` hat die folgenden Methoden deklariert, um die Antworten `200` und `206` zurückzugeben:

```
GET /a
POST /a
```

und `A` deklariert die folgende Methode, um die Antworten `200` und `400` zurückzugeben:

```
GET /a
```

Wenn `A` mit `B` zusammengeführt wird, ergibt die resultierende API die folgenden Methoden:

```
GET /a
```

die `200`- und `400`-Antworten ausgibt, und 

```
POST /a
```

die `200`- und `206`-Antworten ausgibt.

Die Zusammenführung einer API empfiehlt sich, wenn Sie die externen API-Definitionen in mehrere kleinere Teile zerlegt haben und nur die Änderungen eines dieser Teile anwenden möchten. Dies kann z. B. der Fall sein, wenn für die verschiedenen Teile einer API mehrere Teams zuständig sind, die in unterschiedlichem Tempo Änderungen vornehmen möchten. In diesem Modus bleiben Elemente einer vorhandenen API, die in der importierten Definition nicht speziell definiert wurden, als eigenständige Elemente erhalten. 

Wenn eine API (`A`) eine andere API (`B`) überschreibt, übernimmt die resultierende API die Definitionen der überschreibenden API (`A`). Das Überschreiben einer API empfiehlt sich, wenn eine externe API-Definition die vollständige Definition einer API enthält. In diesem Modus werden Elemente einer vorhandenen API, die in der importierten Definition nicht speziell definiert wurden, gelöscht. 

 Wenn Sie eine API zusammenführen möchten, übermitteln Sie eine `PUT`-Anforderung an `https://apigateway.<region>.amazonaws.com/restapis/<restapi_id>?mode=merge`. Der Wert `restapi_id` des Parameters "path" gibt die API an, mit der die bereitgestellte API-Definition zusammengeführt wird. 

 Das folgende Codefragment zeigt ein Beispiel für die `PUT`-Anfrage zum Zusammenführen einer OpenAPI-Definition in API – als Nutzlast – mit der angegebenen JSON, die sich bereits in API Gateway befindet. 

```
PUT /restapis/<restapi_id>?mode=merge
Host:apigateway.<region>.amazonaws.com
Content-Type: application/json
Content-Length: ...

An OpenAPI API definition in JSON
```

 Bei einer Aktualisierung mittels Zusammenführung werden zwei vollständige API-Definitionen miteinander verbunden. Für geringfügige und inkrementelle Änderungen können Sie die Operation zur [Ressourcenaktualisierung](https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateResource.html) verwenden. 

 Wenn Sie eine API überschreiben möchten, übermitteln Sie eine `PUT`-Anforderung an `https://apigateway.<region>.amazonaws.com/restapis/<restapi_id>?mode=overwrite`. Der Wert `restapi_id` des Parameters "path" gibt die API an, die durch die bereitgestellten API-Definitionen überschrieben wird. 

 Das folgende Codefragment zeigt ein Beispiel für eine Überschreibungsanforderung mit der Nutzlast einer JSON-formatierten OpenAPI-Definition: 

```
PUT /restapis/<restapi_id>?mode=overwrite
Host:apigateway.<region>.amazonaws.com
Content-Type: application/json
Content-Length: ...

An OpenAPI API definition in JSON
```

 Wenn der Abfrageparameter `mode` fehlt, wird von einer Zusammenführung ausgegangen.

**Anmerkung**  
 Die `PUT`-Operationen sind idempotent, aber nicht atomar. Das heißt, wenn während der Verarbeitung ein Systemfehler auftritt, kann die API letztlich einen fehlerhaften Zustand annehmen. Bei erfolgreicher wiederholter Ausführung der Operation nimmt die API jedoch den endgültigen Zustand an, den sie auch bei erfolgreicher Ausführung der ersten Operation erreicht hätte. 

# Die `basePath`-Eigenschaft von OpenAPI einrichten
<a name="api-gateway-import-api-basePath"></a>

In [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) können Sie mit der `basePath`-Eigenschaft einen oder mehrere Pfadbestandteile bereitstellen, die jedem in den `paths`-Eigenschaften definierten Pfad vorangestellt werden. In API Gateway gibt es mehrere Möglichkeiten, den Pfad einer Ressource auszudrücken daher bietet auch die Funktion zum Importieren von APIs drei Optionen für die Interpretation der `basePath`-Eigenschaft während eines Importvorgangs: Ignorieren, Voranstellen und Splitten.

In [https://swagger.io/docs/specification/api-host-and-base-path/](https://swagger.io/docs/specification/api-host-and-base-path/) ist `basePath` keine Top-Level-Eigenschaft mehr. Stattdessen verwendet API Gateway eine [Servervariable](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#serverVariableObject) als Konvention. Die Funktion zum Importieren von APIs bietet die gleichen Optionen für die Interpretation der Basispfades während des Imports. Der Basispfad wird wie folgt identifiziert:
+ Wenn die API keine `basePath`-Variablen aufweist, überprüft die Funktion zum Importieren von APIs, ob die `server.url`-Zeichenfolge einen Pfad außer `"/"` enthält. Wenn dies der Fall ist, wird dieser Pfad als Basispfad verwendet.
+ Wenn die API nur eine `basePath`-Variable enthält, verwendet die Funktion zum Importieren von APIs diese als Basispfad, auch wenn sie nicht in `server.url` referenziert wird.
+ Wenn die API mehrere `basePath`-Variablen enthält, verwendet die Funktion zum Importieren von APIs nur den ersten Eintrag als Basispfad.

## Ignore
<a name="api-gateway-import-api-basePath-ignore"></a>

Wenn in der OpenAPI-Datei der `basePath`-Wert `/a/b/c` lautet und die `paths`-Eigenschaft `/e` und `/f`enthält, führt die folgende `POST`- oder `PUT`-Anforderung: 

```
POST /restapis?mode=import&basepath=ignore
```



```
PUT /restapis/api_id?basepath=ignore
```

 führt dies zu den folgenden Ressourcen in der API: 
+ `/`
+ `/e`
+ `/f`

 Dadurch wird die `basePath`-Eigenschaft so behandelt, als sei sie nicht vorhanden, und alle deklarierten API-Ressourcen werden relativ zum Host bereitgestellt. Dies empfiehlt sich z. B., wenn Sie einen benutzerdefinierten Domänennamen mit einem API-Mapping ohne einen Wert für den *Basispfad* und mit einem Wert für die *Phase* (die sich auf Ihre Produktionsphase bezieht) haben. 

**Anmerkung**  
 API Gateway erstellt automatisch eine Root-Ressource für Sie, auch wenn diese nicht explizit in Ihrer Definitionsdatei deklariert ist. 

 Wenn nicht angegeben, wird `basePath` standardmäßig auf `ignore` gesetzt. 

## Voranstellen
<a name="api-gateway-import-api-basePath-prepend"></a>

 Wenn in der OpenAPI-Datei der Wert der `basePath`-Eigenschaft lautet und die `/a/b/c`-Eigenschaft `paths`und`/e` enthält, führt die folgende `/f`POST- oder `POST``PUT`PUT-Anforderung: 

```
POST /restapis?mode=import&basepath=prepend
```



```
PUT /restapis/api_id?basepath=prepend
```

 führt dies zu den folgenden Ressourcen in der API: 
+ `/`
+ `/a`
+ `/a/b`
+ `/a/b/c`
+ `/a/b/c/e`
+ `/a/b/c/f`

 Dadurch wird die Eigenschaft `basePath` so behandelt, als würde sie zusätzliche Ressourcen (ohne Methoden) angeben und diese zum deklarierten Ressourcensatz hinzufügen. Dies empfiehlt sich z. B., wenn verschiedene Teams für die verschiedene Teile einer API zuständig sind und die Eigenschaft `basePath` auf den Pfadpfadspeicherort des API-Teils der einzelnen Teams verweisen kann. 

**Anmerkung**  
 API Gateway erstellt automatisch Zwischenstufen von Ressourcen für Sie, auch wenn Sie diese nicht ausdrücklich in der Definition deklariert haben. 

## Teilen
<a name="api-gateway-import-api-basePath-split"></a>

 Wenn in der OpenAPI-Datei der Wert der `basePath`-Eigenschaft lautet und die `/a/b/c`-Eigenschaft `paths`und`/e` enthält, führt die folgende `/f`POST- oder `POST``PUT`PUT-Anforderung: 

```
POST /restapis?mode=import&basepath=split
```



```
PUT /restapis/api_id?basepath=split
```

 führt dies zu den folgenden Ressourcen in der API: 
+ `/`
+ `/b`
+ `/b/c`
+ `/b/c/e`
+ `/b/c/f`

 Dadurch wird die oberste Ebene des Pfades (`/a`) als Beginn aller Pfade der Ressource behandelt und es werden zusätzliche Ressourcen (keine Methoden) in der API an sich erstellt. Das empfiehlt sich z. B., wenn `a` ein Phasenname ist, den Sie als Teil Ihrer API bereitstellen möchten. 

# AWS Variablen für den OpenAPI-Import
<a name="import-api-aws-variables"></a>

Sie können die folgenden AWS Variablen in OpenAPI-Definitionen verwenden. API Gateway löst die Variablen auf, wenn die API importiert wird. Um eine Variable anzugeben, verwenden Sie `${variable-name}`. In der folgenden Tabelle werden die verfügbaren AWS Variablen beschrieben. 


| Variablenname | Description | 
| --- | --- | 
| AWS::AccountId | Die AWS Konto-ID, die die API importiert. Zum Beispiel: 123456789012. | 
| AWS::Partition | Die AWS Partition, in die die API importiert wird. Für AWS Standardregionen ist die Partitionaws. | 
| AWS::Region | Die AWS Region, in die die API importiert wird. Beispiel, us-east-2. | 

## AWS Beispiel für Variablen
<a name="import-api-aws-variables-example"></a>

Im folgenden Beispiel AWS werden Variablen verwendet, um eine AWS Lambda Funktion für eine Integration zu spezifizieren.

------
#### [ OpenAPI 3.0 ]

```
openapi: "3.0.1"
info:
  title: "tasks-api"
  version: "v1.0"
paths:
  /:
    get:
      summary: List tasks
      description: Returns a list of tasks
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Task"
        500:
          description: "Internal Server Error"
          content: {}
      x-amazon-apigateway-integration:
        uri:
          arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:${AWS::Partition}:lambda:${AWS::Region}:${AWS::AccountId}:function:LambdaFunctionName/invocations
        responses:
          default:
            statusCode: "200"
        passthroughBehavior: "when_no_match"
        httpMethod: "POST"
        contentHandling: "CONVERT_TO_TEXT"
        type: "aws_proxy"
components:
  schemas:
    Task:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
```

------

# Fehler und Warnungen beim Import Ihrer API in API Gateway
<a name="api-gateway-import-api-errors-warnings"></a>

Wenn Sie Ihre externe Definitionsdatei in API Gateway importieren, generiert API Gateway möglicherweise Warnungen und Fehler. In den folgenden Abschnitten werden die Fehler und Warnungen behandelt, die beim Import auftreten können.

## Fehler beim Import
<a name="api-gateway-import-api-errors"></a>

 Während des Imports werden für schwerwiegende Probleme wie ungültige OpenAPI-Dokumente Fehler generiert. Fehler werden in Form von Ausnahmen als Antwort auf eine erfolglose Aktion zurückgegeben (z. B. `BadRequestException`). Wenn ein Fehler auftritt, wird die neue API-Definition verworfen und die vorhandene API wird unverändert beibehalten. 

## Warnungen beim Import
<a name="api-gateway-import-api-warnings"></a>

 Während des Imports werden für kleinere Probleme wie fehlende Modellreferenzen Warnungen generiert. Falls eine Warnung auftritt, wird der Vorgang fortgesetzt, wenn an die Anforderungs-URL der Abfrageausdruck `failonwarnings=false` angehängt wird. Andernfalls werden die Aktualisierungen rückgängig gemacht. `failonwarnings` ist standardmäßig auf `false` festgelegt. In solchen Fällen werden Warnungen als Feld in der resultierenden [RestApi](https://docs.aws.amazon.com/apigateway/latest/api/API_RestApi.html)Ressource zurückgegeben. Andernfalls werden Warnungen als Nachricht in der Ausnahme ausgegeben. 

# REST-API von API Gateway importieren
<a name="api-gateway-export-api"></a>

 Sobald Sie eine REST-API in API Gateway erstellt und konfiguriert haben, können Sie sie mit der API Gateway-Konsole oder anderweitig in eine OpenAPI-Datei exportieren, und zwar mit der API Gateway-Export-API, die Teil des Amazon API Gateway-Control-Service ist. Um die API-Gateway-Export-API verwenden zu können, müssen Sie Ihre API-Anforderungen signieren. Weitere Informationen zum Signieren von Anfragen finden Sie unter [Signieren von AWS API-Anfragen](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) im *IAM-Benutzerhandbuch*. Ihnen stehen Optionen zur Verfügung, die API Gateway-Integrationserweiterungen sowie die [Postman](https://www.postman.com)-Erweiterungen in die exportierte OpenAPI-Definitionsdatei aufzunehmen. 

**Anmerkung**  
Achten Sie beim Exportieren der API mithilfe von darauf AWS CLI, den Erweiterungsparameter anzugeben, wie im folgenden Beispiel gezeigt, um sicherzustellen, dass die `x-amazon-apigateway-request-validator` Erweiterung enthalten ist:  

```
aws apigateway get-export --parameters extensions='apigateway' --rest-api-id abcdefg123 --stage-name dev --export-type swagger latestswagger2.json
```

 Sie können eine API nicht exportieren, wenn deren Nutzlast nicht vom Typ `application/json` ist. Wenn Sie dies versuchen, erhalten Sie eine Fehlermeldung, die besagt, dass JSON-Textmodelle nicht gefunden wurden. 

## Anfordern zum Exportieren einer REST-API
<a name="api-gateway-export-api-request"></a>

 Mit der Export-API exportieren Sie eine vorhandene REST-API, indem Sie eine GET-Anfrage einreichen und die to-be-exported API als Teil der URL-Pfade angeben. Der Anforderungs-URL hat das folgende Format: 

------
#### [ OpenAPI 3.0 ]

```
 https://<host>/restapis/<restapi_id>/stages/<stage_name>/exports/oas30
```

------
#### [ OpenAPI 2.0 ]

```
 https://<host>/restapis/<restapi_id>/stages/<stage_name>/exports/swagger
```

------

 Sie können die Abfragezeichenfolge `extensions` anhängen, um anzugeben, ob API Gateway-Erweiterungen (mit dem Wert `integration`) oder Postman-Erweiterungen (mit dem Wert `postman`) enthalten sein sollen. 

 Darüber hinaus können Sie den Header `Accept` auf `application/json` oder `application/yaml` festlegen, um die API-Definitionsausgabe im JSON- bzw. YAML-Format zu erhalten. 

 Weitere Informationen zum Einreichen von GET-Anfragen mit der API Gateway Export API finden Sie unter [GetExport](https://docs.aws.amazon.com/apigateway/latest/api/API_GetExport.html). 

**Anmerkung**  
 Wenn Sie Modelle in Ihrer API definieren, müssen diese für den Inhaltstyp "application/json" sein, damit API Gateway das Modell exportieren kann. Andernfalls löst API Gateway eine Ausnahme mit der Fehlermeldung "Only found non-JSON body models for ..." aus.   
 Modelle müssen Eigenschaften enthalten oder als ein bestimmter JSONSchema Typ definiert sein. 

## Herunterladen der REST-API-OpenAPI-Definition als JSON
<a name="api-gateway-export-api-download-swagger-json"></a>

So exportieren und laden Sie eine REST-API in OpenAPI-Definitionen im JSON-Format herunter:

------
#### [ OpenAPI 3.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/oas30
Host: apigateway.<region>.amazonaws.com
Accept: application/json
```

------
#### [ OpenAPI 2.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/swagger
Host: apigateway.<region>.amazonaws.com
Accept: application/json
```

------

 Hier kann `<region>` beispielsweise `us-east-1` sein. Informationen zu den Regionen, in denen API Gateway verfügbar ist, finden Sie unter [Regionen und Endpunkte](https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). 

## Herunterladen der REST-API-OpenAPI-Definition als YAML
<a name="api-gateway-export-api-download-swagger-yaml"></a>

So exportieren und laden Sie eine REST-API in OpenAPI-Definitionen im YAML-Format herunter:

------
#### [ OpenAPI 3.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/oas30
Host: apigateway.<region>.amazonaws.com
Accept: application/yaml
```

------
#### [ OpenAPI 2.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/swagger
Host: apigateway.<region>.amazonaws.com
Accept: application/yaml
```

------

## Herunterladen der REST-API-OpenAPI-Definition mit Postman-Erweiterungen als JSON
<a name="api-gateway-export-api-download-swagger-json-with-postman"></a>

So exportieren und laden Sie eine REST-API in OpenAPI-Definitionen mit Postman im JSON-Format herunter:

------
#### [ OpenAPI 3.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/oas30?extensions=postman
Host: apigateway.<region>.amazonaws.com
Accept: application/json
```

------
#### [ OpenAPI 2.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/swagger?extensions=postman
Host: apigateway.<region>.amazonaws.com
Accept: application/json
```

------

## REST-API OpenAPI-Definition mit API Gateway-Integration in YAML herunterladen
<a name="api-gateway-export-api-download-swagger-yaml-with-apig"></a>

So exportieren Sie eine REST-API in OpenAPI-Definitionen mit API Gateway-Integration im YAML-Format und laden Sie herunter:

------
#### [ OpenAPI 3.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/oas30?extensions=integrations
Host: apigateway.<region>.amazonaws.com
Accept: application/yaml
```

------
#### [ OpenAPI 2.0 ]

```
GET /restapis/<restapi_id>/stages/<stage_name>/exports/swagger?extensions=integrations
Host: apigateway.<region>.amazonaws.com
Accept: application/yaml
```

------

## REST-API über die API-Gateway-Konsole exportieren
<a name="api-gateway-export-api-from-console"></a>

Nach der [Bereitstellung Ihrer REST-API für eine Stufe](set-up-deployments.md#create-deployment) können Sie mit der API Gateway-Konsole die API in der Stufe in eine OpenAPI-Datei exportieren.

 Wählen Sie in der API-Gateway-Konsole im Bereich **Stufen** die Optionen **Stufenaktionen** und **Export** aus.

![\[REST-API über die API-Gateway-Konsole exportieren\]](http://docs.aws.amazon.com/de_de/apigateway/latest/developerguide/images/export-new-console.png)


Geben Sie einen **API-Spezifikationstyp**, ein **Format** und **Erweiterungen** an, um die OpenAPI-Definition Ihrer API herunterzuladen. 