docs: add API response validation example to basic usage #3889
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for guileless-rolypoly-866f8a ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
braden-w
force-pushed
the
docs/add-validating-API-responses-section
branch
from
d8d20a6 to
84e9526
Compare
braden-w
force-pushed
the
docs/add-validating-API-responses-section
branch
from
84e9526 to
b6c623e
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Basic Usage section currently shows simple schema validation but doesn't demonstrate one of Zod's most common use cases: validating API responses. Since API validation is often the entry point for developers discovering Zod, adding this example early in the documentation helps readers understand a practical, real-world application.
The example demonstrates:
This addition bridges the gap between the existing primitive examples and more complex use cases, providing a clear path for new users to understand Zod's value proposition.