Sie können API Agent verwenden, um schnell ein OpenAPI Dokument aus einer vorhandenen Datenbanktabelle oder einer IBM Connector Pack-basierten Anwendung zu erstellen. Das generierte OpenAPI Dokument liegt im YAML-Format vor und kann für die API-Entwicklung, das Testen und die Veröffentlichung verwendet werden.
Vorgehensweise
- Melden Sie sich bei API Agent an. Weitere Informationen finden Sie unter Erste Schritte.
- Geben Sie eine Aufforderung zur Erstellung eines OpenAPI Dokuments aus einer bestehenden Datenbank ein und klicken Sie auf Senden.
Beispiel:
Hinweis: Der Schemaname ist nicht zwingend erforderlich, aber er wird notwendig, wenn der Tabellenname nicht eindeutig ist.
Das Tool OAS Creator kommuniziert mit den
API-Agent-Quellen und zeigt den vorgeschlagenen Plan an.
- Um die Ergebnisse anzuzeigen, klicken Sie auf Start. Die API Agent generiert das Dokument OpenAPI im YAML-Format.
- Klicken Sie auf Download, um die YAML-Datei zu speichern.
- Um die heruntergeladene YAML-Datei zu betrachten, öffnen Sie den Explorer im linken Bereich von Visual Studio Code.