会話に参加する
シーケンス図の使い方
参加者、呼び出し、応答、分岐、ノートを使って、順序のある API・サービス間のやり取りを作成します。
会話をフォローする
シーケンス図は、人、サービス、システムの間の相互作用を表現する独立したビジュアルワークスペースです。参加者は左から右へ配置され、時間はページの下に向かって流れます。フローのアウトラインと図は、同じ順序付けられたモデルを表示します。
API リクエストテンプレートを選択して、クライアント、Orders API、Auth サービス、およびデータベースを探索します。このテンプレートはトークンを検証し、if/else グループを使用して注文または未承認のレスポンスを返します。「空白の図」を選択して、独自の会話を作成します。
API インタラクションを構築する
- Client および API の参加者を追加します。[フロー] パネルまたは図上で 1 つ選択し、名前、シンボル、色、および左から右への順序を編集します。
- 空白のキャンバスは、参加者と最初のメッセージをご案内します。新しい名前とメッセージテキストが選択されるため、すぐに入力できます。「メッセージ」を選択し、「詳細」で From、To、Message を編集します。「追加」バーには、新しいステップの挿入先とメッセージの送信者が表示されます。メッセージは、同じブランチ内の選択したステップの後に追加されます。参加者を選択すると、その参加者から次のメッセージが開始されます。選択したメッセージはそのエンドポイントを提供します。選択した参加者から追加されたノートは、そのアンカーを使用します。ステップが選択されていない場合、メインフローに追加されます。
- メッセージを選択し、「このメッセージの後に返信を追加」を使用してエンドポイントを反転させ、破線の戻り線を追加します。ステップをドラッグして時間軸上に配置します。プレビューにはその宛先が表示されます。フローの上下コントロールで現在のブランチ内の順序を変更します。
- 「グループ」→「If / else」、「Optional」、「Loop」、または「Parallel」を使用します。ブランチを選択してその条件を編集したり、そこにステップを追加したりします。「ブランチを追加」は else フォールバックの前に挿入されます。Flow では、各ブランチに独自の + ボタンがあります。
- チェックを実行し、図を確認し、結果を保存またはエクスポートします。スマートフォンでは、「フロー」、「図」、「詳細」タブを使用します。「詳細の編集」で選択した要素が開き、「図に戻る」でキャンバスに戻ります。
図上で選択、移動、追加を行う
参加者のヘッダーまたはライフライン、メッセージ、ノート、グループの境界線、または分岐領域をクリックして選択します。Enter または Space キーを押して詳細を開きます。参加者のヘッダーを左右にドラッグして間隔と順序を調整し、メッセージ、ノート、またはグループ全体を垂直方向にドラッグして時間順序を設定し、ギャップを残します。タッチスクリーンでは、表示されているグリップをドラッグし、それ以外の場所をスワイプしてスクロールします。
プレビューには提案された図が表示され、その移動先ブランチに名前が付けられます。別のブランチにドロップしてステップを移動するか、「詳細」の「ステップを移動」を使用します。作成と削除はメインフローに留まります。グループは自身の内部に移動できません。ドラッグは 8 ピクセルにスナップします。Escape またはキャンセルを行うとモデルは変更されません。離すと、元に戻すことができる変更が 1 つ行われます。「整理」を実行すると、順序とブランチを維持しながら自動間隔が復元されます。
追加バーをクリックするか、デスクトップ上で参加者、メッセージ、ノート、またはグループをダイアグラム上にドラッグします。グループの選択肢では、If / else、Optional、Loop、Parallel が平易な言葉で説明されます。ドロッププレビューとキャンバスのフッターには、宛先の分岐の名前とその時間的な位置が表示されます。パレットのドラッグは最初の 2 人の参加者から始まり、方向はドラッグ中に表示されます。詳細でメッセージのエンドポイントを選択します。ライフラインの近くにドロップしても、エンドポイントは変更されません。
空のキャンバスをクリックして選択を解除します。空のキャンバスをドラッグするか、中マウスボタンを使用して、選択を維持したまま探索します。参加者の前にグループを追加できます。キャンバスのプレースホルダーと「Flow +」ボタンで最初の参加者を追加し、最初のメッセージを提案します。
参加者とライフライン
Participant、Actor、Boundary、Control、Entity、および Database により、ヘッダーのシンボルが変更されます。これらはデータベーステーブルではなく、インタラクション内の役割です。名前と任意の不透明な16進数アクセントカラーがダイアグラムとともに保存されます。
参加者のヘッダーをドラッグして位置を調整します。読みやすさを維持するため、近くのヘッダーが脇に移動します。「左へ移動」および「右へ移動」は、表示順序での位置を入れ替えます。メッセージのエンドポイントは変更されません。「参加者の詳細」には、「メッセージの送信」および「メモの追加」のアクションが用意されています。同じ参加者へのメッセージは自動的に自己呼び出しになり、1人の参加者の図ではこれが明示的に提供されます。参加者を削除すると、それに関連するメッセージが削除され、メモからそのアンカーも削除されます。「元に戻す」ですべての変更が復元されます。
呼び出し、返信、およびライフタイム
| 種類 | 意味 |
|---|---|
| 同期呼び出し | 実線と塗りつぶした矢印。送信者は呼び出された操作を待ちます。 |
| 非同期メッセージ | 実線と開いた矢印。送信者は待たずに処理を継続できます。 |
| 返信 / 戻り | 呼び出し元に戻る破線。[返信の追加]で、選択したメッセージのエンドポイントが反転します。 |
| 参加者を作成 | 作成は、ターゲット ライフラインの最初のインタラクションで行われます。そのヘッダーはこのメッセージから始まります。 |
| 参加者を破棄 | X はターゲットの破壊を示します。これが最後のやり取りとなるはずです。 |
意味を失うことなくブランチをグループ化する
If / else (alt) には 2〜6 の代替ブランチが含まれ、一致するオペランドが正確に 1 つ選択されます。Optional (opt) には条件付きブランチが 1 つ含まれます。Loop には繰り返しブランチが 1 つ含まれます。反復条件を記述してください。Parallel (par) には、相互作用がインターリーブする可能性のある 2〜6 のオペランドが含まれます。
ブランチの所属は明示的です。フローボタンと Alt+Up/Down により、ステップを現在のブランチ内に保持できます。ドラッグすると、メッセージ、メモ、またはグループ全体をプレビューに表示されているブランチに転送できます。[ステップの移動先] でも [詳細] で同じ選択肢を提供します。グループをそれ自身の中にネストする、4つのネストレベルを超える、または作成/破棄をブランチ内に配置するなど、無効な移動先は理由とともに無効化されます。
マルチブランチグループを Optional または Loop に変更すると、最初のブランチのみを残すかどうかの確認を求められます。ブランチを削除すると、そのステップを削除するかどうかの確認を求められます。1つのブランチが残った場合、グループは Optional になり、唯一のブランチを削除するとグループが削除されます。グループを削除すると、確認の上ですべてのステップが削除されます。「元に戻す」を実行すると、変更が完全に復元されます。並行ブランチの垂直方向の配置は、それらの間の実行順序を意味するものではありません。
ノート、番号付け、およびアクティベーション
ノートを追加し、対象とする参加者を選択します。ノートはそのフレーム内で折り返され、シーケンスの順序に合わせて移動します。メッセージの矢印に段落を配置する代わりに、制約や説明に使用してください。
表示コントロールには、メッセージ番号と自動アクティベーションバーが含まれます。これらの外観オプションは保存され、画像エクスポートに含まれます。番号は読み取り順序を提供するものであり、測定されたタイムスタンプや並列ブランチ全体の総実行順序ではありません。
アクティベーションバーは同期的呼び出しから推測され、応答が描画されます。自己呼び出しはネストできます。代替ブランチは個別に計算されるため、一方のブランチの応答が別のブランチの呼び出しを終了することはありません。応答が欠落している場合、アクティベーションはそのスコープの終わりまで開いたままになります。これは実行分析というよりは視覚的な補助です。
新しい図は読みやすい縮尺で開始されます。幅の広い図は水平方向にスクロールできます。「図の幅に合わせる」を選択すると、垂直方向の読みやすさを維持しながら全体像を把握できます。スクロールして探索するか、ズームコントロールを使用するか、Ctrl/Commandキーを押しながらスクロールしてポインターを中心にズームします。「検索」では、参加者名や型、メッセージとそのエンドポイント、ノート、グループの説明、条件を検索できます。一致するステップは関連するブランチのコンテキストを保持し、IDと位置は除外されます。クリアまたはEscapeキーでフロー全体が復元され、結果が空の場合は試すべき内容が表示されます。フローやチェックの結果を選択するか、要素を追加すると、ズームを変更せずにそのラベルが表示されます。スマートフォンでは、図に戻ったときにこれが発生します。キャンバスのスクロール、ズーム、選択はドキュメントや取り消し履歴の外側にあるワークスペースビューです。
保存、共有、およびインポート
新しい図はメモリ内に残ります。必要なときに「保存」でサインインし、独立したシーケンス図のクラウドファイルを作成します。「ファイル」→「シーケンス図を開く」を開くと、独自のファイルリストが開きます。読み取り専用の公開リンクを共有する前に、最新の変更を保存してください。公開ビューアーはファイルの検査とエクスポートを行えますが、編集はできません。
「ファイル」→「JSON のダウンロード」により、参加者の位置やステップの間隔を含む完全な編集可能ドキュメントが保持されます。クラウド保存や画像エクスポートでも、この配置が保持されます。「JSON のインポート」は、最大 4 MB のエクスポートされた Erd Go シーケンス図バージョン 1 ファイルを受け入れ、置き換え前にファイル全体を検証し、元に戻す(Undo)をサポートします。古いファイルは自動スペーシングを維持し、重なり合うインポートされた位置は安全に表示されます。SQL、クラス図、Mermaid、および PlantUML はインポート形式ではありません。
「ファイル」→「新規ダイアグラム」により、空/テンプレート選択画面が再度開きます。「空」および「API リクエスト例」は、確認と元に戻す(Undo)の機能付きで既存のモデルを置き換えます。保存されていないダイアグラムは、離れたりリロードしたりする前に確認を促します。ブラウザのストレージには何も書き込まれません。
図またはテキストソースのエクスポート
エクスポートでは、PNG、JPEG、WebP、スタンドアロンのベクター SVG、または画像ベースの PDF が作成されます。[図全体] または [現在のビュー] (携帯電話では最初に [図] パネルを開きます) と、HD、2K、または 4K の幅を選択します。ラスターの寸法は 1 辺あたり最大 8192 ピクセル、1,600万ピクセルに制限されており、非常に背の高い図は縮小される場合があります。スケーラブルな大きな図には SVG を使用し、読みやすいセクションには [現在のビュー] を使用します。
「ファイル」→「PlantUML / Mermaid のエクスポート」は、ローカルテキストのプレビュー、コピー、およびダウンロードを行います。テキストレンダラーは自身のレイアウトと外観を制御するため、参加者の記号や色が異なる場合があります。JSON は完全な編集可能なフォーマットです。ソースがサードパーティのレンダリングサーバーに送信されることはありません。
sequenceDiagram
participant Client
participant API
participant Auth
participant Database
Client ->> API: GET /orders
API ->> Auth: verify token
Auth -->> API: identity
alt valid token
API ->> Database: SELECT orders
Database -->> API: orders[]
API -->> Client: 200 OK
else invalid token
API -->> Client: 401 Unauthorized
endショートカットと制限事項
| アクションまたは制限 | 動作 |
|---|---|
| Ctrl/Cmd+S | クラウドに保存。プロンプトが表示されたらサインインしてください。 |
| Ctrl/Cmd+K | フローパネルで「検索」を開いてフォーカスします。 |
| Ctrl/Cmd+Z / Shift+Z / Ctrl+Y | テキストフィールド外での「元に戻す / やり直し」。テキストフィールドでは標準の編集ショートカットが保持されます。 |
| Enter / スペース | フォーカスされている図要素の詳細を開きます。 |
| Alt+Left / Right | 選択した参加者を左または右に移動します。 |
| Alt+Up / Down | 選択したステップを現在のブランチ内で移動します。 |
| 削除 / バックスペース | テキストフィールド外の選択範囲を削除するか、キャンバスのゴミ箱ボタンを使用します。参加者のカスケードおよびグループ/ブランチの削除には確認が求められます。 |
| ドラッグ中の Escape | モデルを変更せずにプレビューをキャンセルします。 |
| 整理する | 順序やブランチを変更せずに自動スペーシングを復元します。「元に戻す」で配置が復元されます。 |
| 参加者とステップ | 30人の参加者と合計300のステップ(フラグメントとノートを含む)。 |
| テキスト | 参加者名あたり80文字、メッセージ/条件/グループのラベルあたり240文字、ノートあたり2,000文字。 |
| ファイルと履歴 | 4 MBのインポートされたJSON、3~255文字のクラウドファイル名、80個の元に戻す状態。 |
レビューとトラブルシューティング
チェックにより、空の名前、重複する参加者名、欠落しているメッセージラベル、空のブランチ、欠落している条件、および一貫性のない作成または破棄の順序がフラグ付けされます。検出結果を選択すると、その詳細が表示されます。これらのチェックは、会話を実行したり、API の動作を証明したりするものではありません。
インポートが失敗した場合でも、現在の図はそのまま維持されます。古い保留中のファイルの読み込みによって、より新しいドキュメント、より新しいインポート、または編集されたモデルを置き換えることはできません。クラウドへの保存が失敗した場合は、図を開いたままにし、退出する前に JSON をダウンロードしてください。
相互作用表記の意味については、OMG UML 仕様を使用してください。PlantUML と Mermaid には独自のテキスト構文があります。生成されたファイルはそれらのツールへのエクスポート用であり、Erd Go のインポート言語ではありません。