1. Resolving Broken Schema References
API Platform EngineerBackground
An engineer is updating a microservice API contract and gets errors when generating client libraries due to unresolved references.
Problem
The API specification contains multiple nested $ref pointers, and some point to non-existent schemas in the components section.
How to use
Paste the YAML specification into the input area and click validate to locate the exact line numbers of the broken $ref definitions.
openapi: 3.0.0
info:
title: Broken Ref API
version: 1.0.0
paths:
/users:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserNonExistent'Outcome
The validator flags the missing '#/components/schemas/UserNonExistent' reference, allowing the engineer to quickly define the missing schema.