Javadoc generieren und auf Javadoc zugreifen

Standardmäßig ist Javadoc nicht Teil des Laufzeitimages oder des extrahierten Laufzeitverzeichnisses. Sie müssen die Javadoc-Dateien generieren, um auf sie zuzugreifen.

Bevor Sie beginnen

Stellen Sie sicher, dass Sie über eine Kopie der extrahierten Laufzeit verfügen (siehe Angepasste Erweiterungen aktualisieren).

Informationen zu diesem Vorgang

Javadoc ist nicht Teil des Laufzeitimages oder des extrahierten Laufzeitverzeichnisses. Sie müssen sie zuerst generieren, damit Sie darauf zugreifen können.

Vorgehensweise

  1. Navigieren Sie zum Generieren der Javadoc-Dateien zum Ordner extracted_runtime/bin und führen Sie den Befehl
    bash ./sci_ant.sh -f ../properties/xapiDeployer.xml alldocs aus.
  2. Wechseln Sie zum Ordner extracted_runtime/xapidocs .
  3. Öffnen Sie die Datei index.html im entsprechenden Verzeichnis auf der Basis des Dokumenttyps, auf den Sie zugreifen möchten. Beispiel: api_javadocs, propertydocsoder cufdocs.

    Der Ordner swaggerdoc bietet eine detaillierte und interaktive Übersicht über alle REST-APIs von Sterling™ Order Management System. Die Verfügbarkeit der OpenAPI Swagger-Dokumentation ergänzt die bestehende Javadoc, indem sie eine standardisierte Darstellung von API-Endpunkten, Anfrage- und Antwortschemata, Parametern und Authentifizierungsdetails in einem OpenAPI 3.0–compliant Format bietet.

    Hinweis: Sie können keine EAR-Datei für Dokumente implementieren. Sie können stattdessen über den Ordner xapidocs auf die Javadoc-Dateien zugreifen.