uip api-workflow init

「uip api-workflow init」の構文とオプション - 新しい API ワークフロー プロジェクトを定型ファイルで構成します。

uip api-workflow init 、新しい API ワークフロー プロジェクト ( project.uiproj、 entry-points.json、 bindings_v2.json、および最小限の Workflow.json を、宣言された入力の既定値と呼び出し元の実際の入力を にマッピングする 1 つのパススルー ステップで構成 $input。ソリューション ディレクトリ内で実行すると、新しいプロジェクトは周囲のソリューションの .uipx ファイルに自動登録されます。

概要

uip api-workflow init <name> [options]

• <name> — API ワークフロー プロジェクト名です。文字、数字、スペース、アンダースコア (_)、およびハイフン (-) のみ。ターゲット ディレクトリ名としても使用されます。

オプション

フラグ	説明
--force	ターゲット ディレクトリが空でなくても初期化します。既存のコンテンツをクリアせずにファイルを書き込みます。既に存在するものは削除されません。
--skip-solution-registration	このプロジェクトを周囲のソリューションに自動登録しないでください。

例

# 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

データシェイプ(--output json)

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

SolutionRegistration 、プロジェクトが親ソリューションの .uipxにリンクされているかどうかを反映します。登録フローでユーザーが手動の手順を実行する必要がある場合 (たとえば、親のソリューションが見つからない場合)、応答には指示を含む NextSteps フィールドが追加されます。

関連

• uip api-workflow build — このコマンドでスキャフォールディングするプロジェクトをコンパイルします。
• uip api-workflow validate — パッケージ化する前にワークフロー JSON を検証します。

参照

• API ワークフロー ツールの概要
• グローバル オプション
• 終了コード