Optionen für die Implementierung einer automatisierten Prüfung

Sie können entweder die Plattform-API oder das CLI (Command Line Interface) verwenden, um die Acrolinx-Prüfung in Ihrem Workflow zur Inhaltserstellung zu automatisieren. Beide Optionen bieten je nach Anwendungsfall unterschiedliche Vorteile. Ein Ansatz könnte die Verwendung des CLI für das Prototyping und die Verwendung der API oder eines SDKs für die Entwicklung der Integration sein.

Entscheidungshilfe

Vergleichen Sie die Vorteile der API und des CLI mit Ihren Anwendungsanforderungen.

Wann ist die API die bessere Option?

• Sie möchten einen Web Service direkt aufrufen.

• Die Installation von Software wie dem CLI in der Ausführungsumgebung ist keine Option.

• Sie brauchen eine hohe Leistung:

  • Sparen Sie sich den Aufwand beim Starten einer ausführbaren Datei.

  • Optimieren Sie alles für Ihren spezifischen Anwendungsfall und Ihre Konfiguration.

  • Die CLI verfügt über eine integrierte Fehlerbehandlung und Befehle zur Ausgabe von Ergebnissen. Wenn Ihr Anwendungsfall nicht von diesen Funktionen profitiert, können Sie die Geschwindigkeit Ihrer Integration erhöhen, indem Sie diese zusätzlichen Aufrufe vermeiden.

• Die CLI unterstützt Ihren speziellen Anwendungsfall noch nicht.

• Wenn Sie möchten, dass Acrolinx mehrere verschiedene Dateien analysiert, die jeweils unterschiedliche Einstellungen erfordern.

Wann ist das CLI die bessere Option?

• Du bist kein Entwickler, aber du weißt, wie ein Befehlszeilen-Skript geschrieben wird. Möglicherweise können Sie eine automatisierte Prüfung ohne zusätzliche Hilfe eines Entwicklers implementieren.

• Sie bevorzugen es, keine zusätzlichen Schritte für die Standardfunktionalität zu machen, die der CLI abdeckt.

• Sie legen Wert auf Robustheit gegenüber Kompatibilitätsänderungen. Die CLI übernimmt die Kommunikation mit der Plattform. Wenn wir die Art und Weise, wie die Integrationen und die Core-Plattform kommunizieren, ändern, werden wir die CLI aktualisieren.

• Das CLI ist eine Standard Acrolinx Integration. Es ist kompatibel mit allen (gültigen) Konfigurationen der Plattform und kann Änderungen in den Konfigurationen verarbeiten. Wenn Sie die API verwenden, um eine Integration zu erstellen, können Sie (unwissentlich) eine bestimmte Konfiguration hart kodieren.

• Sie legen Wert auf Standard-CLI-Features:

  • Ausgabe im Compiler-Stil

  • JSON-Ausgang

  • Ausgabe im XUnit-Stil

  • textbasierte Benutzeroberfläche

• Die CLI ist hoch skriptfähig. Während der Entwicklung stellen wir sicher, dass andere Kommandozeilen-Tools die Ergebnisse verarbeiten können.

• Insbesondere die folgenden Optionen helfen Ihnen, die CLI mit anderen Werkzeugen und Skripten zu kombinieren:

  • Stille-Modus

  • gut durchdachte Ausgabeausgabe an stdout und stderr

  • Verschiedene Optionen für den Exit-Code und zum Failure oder Non-Failure.