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?
- A sample UUID in documentation matches the real format, so developers parse and validate it correctly the first time.
- It also survives schema checks in generated SDKs that expect a UUID type.
How to generate
- Use a fixed, clearly-example UUID in prose.
- Mark it as an example, not a real resource.
- Keep the same value across the doc for consistency.
Use Cases
- API reference pages.
- SDK readmes.
- Postman collections.
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
UUID v1 GeneratorUUID v3 GeneratorUUID v4 GeneratorUUID v5 GeneratorUUID v6 GeneratorUUID v7 GeneratorUUID v8 GeneratorBulk UUID GeneratorShort UUID GeneratorUUID ValidatorUUID FormatterUUID as a Primary KeyUUID Database IDUUID Foreign KeyUUID Shard KeyUUID Partition KeyUUID in a Composite KeyUUID Surrogate KeyUUID API KeyUUID Session TokenUUID Access TokenUUID Refresh TokenUUID Idempotency KeyUUID Request IDUUID Correlation IDUUID Trace IDUUID CSRF TokenUUID NonceUUID FilenameUUID Object KeyUUID S3 KeyUUID Upload IDUUID Cache KeyUUID Blob NameUUID Temp FileUUID User IDUUID Account IDUUID Customer IDUUID Device IDUUID Tenant IDUUID Client IDUUID Anonymous IDUUID Member IDUUID Message IDUUID Event IDUUID Job IDUUID Task IDUUID Queue Message IDUUID Transaction IDUUID Order IDUUID Invoice IDUUID Payment IDUUID Reset TokenUUID Verification TokenUUID Invite CodeUUID API SecretUUID Share LinkUUID Magic LinkUUID Node IDUUID Worker IDUUID Lock IDUUID Cluster IDUUID Test DataUUID Seed DataUUID FixtureUUID Mock IDUUID Placeholder IDUUID Sample ID