UUID Use Case

UUID Sample ID

Docs that show 'id: 123' teach the wrong shape. A UUID sample ID shows readers exactly what to expect.

Doc-accurateValidatesv4

Generated locally with the Web Crypto API — nothing leaves your browser.

What Is UUID Sample ID?

How to generate

  1. Use a fixed, clearly-example UUID in prose.
  2. Mark it as an example, not a real resource.
  3. Keep the same value across the doc for consistency.

Use Cases

Code Examples

Example
{
  "id": "9f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f",
  "name": "example"
}

Frequently Asked Questions

Use a random or fixed sample UUID?
Fixed, so all examples in the doc agree and readers can match them.
Mark it as fake?
A note helps, but the format itself signals it is an example.

Related tools