Ein Beispiel erstellen

Sie fügen Beispiele zu einer API hinzu, um die Spezifikation Ihrer API klarer zu machen.

Vorbereitende Schritte

Starten Sie das Fenster für die Beispielerstellung. Details zu den Bereichen in Ihrer API-Definition, in denen Sie ein Beispiel erstellen können, finden Sie in den folgenden Abschnitten:

Informationen zu dieser Task

Hinweis:

Diese Task bezieht sich auf die Konfiguration einer OpenAPI 3.0-API-Definition. Details zum Konfigurieren einer OpenAPI 2.0 -API-Definition finden Sie unter Bearbeiten einer OpenAPI 2.0 -API-Definition.
OpenAPI 3.0 -APIs werden nur mit dem DataPower® API Gatewayunterstützt, nicht mit dem DataPower Gateway (v5 compatible).
Details zu aktuellen OpenAPI 3.0 -Unterstützungseinschränkungen finden Sie unter OpenAPI 3.0 -Unterstützung in IBM® API ConnectAI Gateway.

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.

Sie können jederzeit direkt zur zugrunde liegenden YAML-Quelle von „ OpenAPI “ wechseln, indem Symbol für OpenAPI -Quelle Sie auf das Symbol „Quelle“ klicken. Um zum Entwurfsformular zurückzukehren, klicken Sie auf das Formular -Symbol Formularsymbol .

Vorgehensweise

Erstellen Sie ein Beispiel. Sie können entweder ein Beispiel von Grund auf neu erstellen oder Sie können ein Beispiel referenzieren, das in einer Beispielkomponente definiert ist.
- Geben Sie die folgenden Informationen auf der Registerkarte Definition an, um das Beispiel völlig neu zu erstellen:
  - Beispielname: Wenn Sie eine Beispielkomponente erstellen, definiert dieser Name einen Schlüssel, der es ermöglicht, dass dieses Beispiel von anderer Stelle in der API-Definition referenziert wird. Die Referenz hat folgendes Format:
```
#/components/examples/Name
```
  - Zusammenfassung: Eine zusammenfassende Beschreibung des Beispiels.
  - Beschreibung: Eine vollständige Beschreibung des Beispiels. Für die Darstellung von Rich Text können Sie die Syntax „ CommonMark “ verwenden.
  - Externer Wert: Eine URL, die auf ein Literalbeispiel verweist. Dies bietet die Möglichkeit, auf Beispiele zu verweisen, die nicht einfach in JSON-oder YAML-Dokumenten eingeschlossen werden können. Dies könnte zum Beispiel eine PDF-Datei sein.
- Geben Sie die folgenden Informationen auf der Registerkarte Referenz an, um ein Beispiel zu referenzieren, das in einer Beispielkomponente definiert ist:
  - Beispielname: Wenn Sie eine Beispielkomponente erstellen, definiert dieser Name einen Schlüssel, der es ermöglicht, dass dieses Beispiel von anderer Stelle in der API-Definition referenziert wird. Die Referenz hat folgendes Format:
```
#/components/examples/Name
```
  - Referenzieren aus: Wählen Sie einen Verweis auf eine Beispielkomponente aus.
Klicken Sie auf Erstellen.
Die Details des Beispiels werden zur weiteren Bearbeitung angezeigt; siehe „Ein Beispiel bearbeiten “.