PlantUML シーケンス図: 基本構文

PlantUML シーケンス図の基本

シーケンス図は、オブジェクトが時間経過とともにどのように相互作用するかを示します。API、マイクロサービス間の通信、ユーザーフローのドキュメントに最もよく使用されるUML図の1つです。

参加者の宣言

@startuml
participant "Web Client" as WC
participant "API Server" as API
database "PostgreSQL" as DB
@enduml

参加者は宣言された順序で表示されます。asキーワードを使用して短いエイリアスを作成します。PlantUMLはparticipant、actor、database、boundary、control、entity、collections、queueなど複数の参加者タイプをサポートしています。

矢印タイプ

矢印	意味
->	実線、塗りつぶし矢印（同期呼び出し）
-->	破線、塗りつぶし矢印（返却/レスポンス）
->>	実線、開いた矢印（非同期）
-->	破線の返却

メッセージの追加

Alice -> Bob: Hello Bob
Bob --> Alice: Hi Alice
Alice ->> Bob: Async message

コロンの後のテキストが矢印上のメッセージラベルになります。メッセージはソースに記述された順序でレンダリングされます。

アクティベーションとデアクティベーション

activateとdeactivateを使用して、参加者が処理中であることを示します：

Client -> Server: Request
activate Server
Server -> DB: Query
activate DB
DB --> Server: Results
deactivate DB
Server --> Client: Response
deactivate Server

メッセージのグループ化

alt、else、opt、loop、par、breakを使用してメッセージをグループ化します：

alt success
  Server --> Client: 200 OK
else failure
  Server --> Client: 500 Error
end