← Back to editor

Practical diagram guide

Mermaid sequence diagram tutorial: client, API, database

Document API requests and responses with an editable Mermaid sequence diagram and a concise syntax walkthrough.

Show who talks to whom

A sequence diagram explains messages between participants in chronological order. It is useful for API calls, authentication flows, and service interactions. This example follows one request from a client to an API and a database, then returns the result.

Understand participants and messages

sequenceDiagram selects the diagram type. A declaration such as participant C as Client separates the short identifier from its display name. Messages run from top to bottom. C->>A: GET /orders sends a solid-arrow message; A-->>C: 200 OK uses a dotted response arrow.

Declare participants explicitly to control their order. Use message labels to explain the action or payload, rather than repeating the participant names.

Add an alternate path

Wrap conditional messages in alt, else, and end. For example, an API can return orders when authentication succeeds, or return an unauthorized response otherwise. Add one branch at a time and check the preview after each edit.

alt Authorized
  A-->>C: 200 OK
else Unauthorized
  A-->>C: 401 Unauthorized
end

Share the result

Use Copy Markdown from the Edit menu to paste a fenced Mermaid block into documentation that supports Mermaid. Use SVG for a scalable illustration, or PNG for a document or slide that accepts images. A share link contains the diagram itself; anyone with that link can read it.

Try it in the editor

Show the conversation between a client, API, and database.

sequenceDiagram
  participant C as Client
  participant A as API
  participant D as Database
  C->>A: GET /orders
  A->>D: Find orders
  D-->>A: Results
  A-->>C: 200 OK
Open this example Download .mmd

Opening the example lets you review it before replacing your current diagram.

Syntax reference: official Mermaid documentation.

Keep exploring