UIP-API-Workflow-Init

Syntax und Optionen für „uip api-workflow init“, das ein neues API-Workflow-Projekt mit Textbaustein-Dateien erstellt.

uip api-workflow init erstellt ein neues API-Workflow-Projekt: project.uiproj, entry-points.json, bindings_v2.json und ein minimales Workflow.json mit einem einzigen Durchlaufschritt, der deklarierte Eingabestandards und dann die tatsächliche Eingabe des Aufrufers in $input zuordnet }. Wenn es in einem Lösungsverzeichnis ausgeführt wird, wird das neue Projekt automatisch in der .uipx -Datei der umgebenden Lösung registriert.

Zusammenfassung

uip api-workflow init <name> [options]

• <name> – Name des API-Workflow-Projekts. Nur Buchstaben, Ziffern, Leerzeichen, Unterstriche (_) und Bindestriche (-) wird auch als Zielverzeichnisname verwendet.

Optionen

Markieren	Beschreibung
--force	Initialisieren Sie auch dann, wenn das Zielverzeichnis nicht leer ist. Schreibt Dateien, ohne vorhandene Inhalte zu löschen – es wird nichts gelöscht, was bereits vorhanden ist.
--skip-solution-registration	Registrieren Sie dieses Projekt nicht automatisch in der Umgebungslösung.

Beispiele

# Create a new API Workflow project
uip api-workflow init my-api-workflow

# Initialize into a non-empty directory
uip api-workflow init my-api-workflow --force

Datenform (--output json)

{
  "Code": "ApiWorkflowInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-api-workflow",
    "SolutionRegistration": {
      "Registered": true
    }
  }
}

SolutionRegistration gibt an, ob das Projekt mit dem .uipx einer übergeordneten Lösung verknüpft wurde. Wenn der Registrierungsablauf erfordert, dass der Benutzer einen manuellen Schritt ausführt (z. B. wurde keine übergeordnete Lösung gefunden), fügt die Antwort ein NextSteps -Feld mit Anweisungen hinzu.

Zugehörig

• uip api-workflow build – kompilieren Sie das Projekt, das dieser Befehl erstellt.
• uip api-workflow validate – Validieren Sie die Workflow-JSON vor dem Packen.

Siehe auch

• Übersicht über das API-Workflow-Tool
• Globale Optionen
• Exitcodes