スタート アップ ガイド

CLI をインストールし、JavaScript または TypeScript 関数プロジェクトをスキャフォールディングして、最初の関数をローカルで実行します。

このページでは、CLI のインストール、プロジェクトのスキャフォールディング、および最初の JavaScript 関数のローカル実行について説明します。

前提条件

• Node.js 20 以降。
• uip CLI と関数ツール:

npm install -g @uipath/cli
uip tools install @uipath/function-tool

• パブリッシュおよび呼び出しに使用する、Orchestrator へのアクセス権を持つ UiPath アカウント。

プロジェクトのスキャフォールディング

uip function new my-functions -l ts
cd my-functions

デフォルトは TypeScript です。JavaScript の場合は -l js を渡すか、サンプル関数をスキップするには --empty を渡します。

この足場は以下を作成します。

ファイル	目的
functions/hello.ts	関数ロジック — ファイルごとに 1 つの関数。実行可能な例として開始されます。
functions/_*.ts	共有ヘルパー。先頭のアンダースコアは、ファイルをヘルパーとしてマークするので、エントリ ポイントもトリガーも取得されません。
uipath.json	関数名をそのエントリ ポイントにマッピングします。
package.json, tsconfig.json	標準のプロジェクト ファイル

最初の関数を記述する

import { defineFunction, defineSchema } from "@uipath/coded-functions-js-sdk";

interface HelloInput {
  name: string;
}

interface HelloOutput {
  message: string;
}

export default defineFunction({
  name: "hello",
  method: "POST",
  path: "/hello",
  input: defineSchema<HelloInput>(),
  output: defineSchema<HelloOutput>(),
  handler: async (input) => ({ message: `Hello, ${input.name}!` }),
});

defineSchema<T>() は TypeScript インターフェイスから JSON スキーマを派生させるため、同じ型がコントラクトを宣言し、ハンドラーに型付けします。JavaScript プロジェクトでは、代わりに JSON スキーマ オブジェクトを渡します。

methodとpathにより、この関数は HTTP 経由で呼び出すことができます。両方を省略すると、ジョブとしてのみ実行されます。「 JavaScript 関数を構築する」をご覧ください。

ローカルで実行する

uip function serve

これにより、ホット リロード サーバーが http://localhost:7070で起動します。関数を呼び出します。

curl -X POST http://localhost:7070/hello \
  -H "Content-Type: application/json" \
  -d '{"name":"Alice"}'
# {"message":"Hello, Alice!"}

ローカル実行から Orchestrator にアクセスするには、 UIPATH_ACCESS_TOKEN、 UIPATH_BASE_URL、 UIPATH_ORG_ID 、および UIPATH_TENANT_ID をプロジェクトのルートにある .env ファイルに書き込みます。serve は、サポートされている両方のランタイムに読み込みます。

次のステップ

• JavaScript 関数の構築 — コントラクト、エラー、および 2 つの関数の形状。
• HTTP トリガーとルーティング — ルート、パス パラメーター、デプロイされた関数の呼び出し。
• パッケージ化してパブリッシュする — Orchestrator にデプロイします。
• CLI リファレンス — すべてのコマンドとフラグ。