Why Aren't My Examples Showing in Swagger UI?
TL;DR: Swagger UI silently ignores examples that don't match the schema type or are missing required fields.
Common Causes
1. Type Mismatch
type: integer
example: "123" # ❌ String, not integer
Fix: Ensure the example matches the declared type:
type: integer
example: 123 # ✓ Correct
2. Missing Required Fields
type: object
required:
- id
- name
properties:
id:
type: integer
name:
type: string
example:
id: 1
# ❌ 'name' is required but missing
Fix: Include all required fields:
example:
id: 1
name: "John Doe" # ✓ All required fields present
Quick Checklist
- Example type matches schema type (string, integer, object, array)
- All required fields are present in object examples
- Enum examples are in the enum list
- No extra quotes around numbers or booleans
Validate Your Examples Automatically
Our OpenAPI Silent Failure Validator checks all your examples for common issues.