- Installation and updates
- Sending your first request
- Navigating Postman
- New button
- Creating the first collection
- Postman account
- Keyboard Shortcuts
- Troubleshooting In-app Issues
- Authorizing requests
- Working with Tabs
- Visualize API responses
- Validating Requests Against Schema
- Generate code snippets
- Using GraphQL
- Making SOAP requests
- Capturing HTTP requests
- Debugging and logs
- Troubleshooting API requests
- Intro to collections
- Creating collections
- Sharing collections
- Commenting on collections
- Managing collections
- Version Control for Collections
- Using Markdown for descriptions
- Data formats
- Working with OpenAPI
- Collaborating in Postman
- Roles and permissions
- Managing your team
- Requesting access
- Team Settings
- Audit logs
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox
- Postman Sandbox API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Building workflows
- Running multiple iterations
- Sharing a collection run
- Working with data files
- Debugging a collection run
- Command line integration with Newman
- Integration with Jenkins
- Integration with Travis CI
- Newman with Docker
- Documenting your API
- Authoring your documentation
- Publishing your docs
- Viewing documentation
- Custom documentation domains
- Intro to mock servers
- Setting up a mock server
- Mocking with examples
- Mocking with the Postman API
- Matching algorithm
- Intro to Monitoring
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- FAQs for monitors
- Intro to Workspaces
- Creating Workspaces
- Using Workspaces
- Managing Workspaces
- Viewing changelogs and restoring collections
- Introduction to APIs
- The API Workflow
- Managing APIs
- Sharing APIs and managing roles
- Versioning APIs
- Viewing and analyzing APIs
- Validating Elements Against Schema
- Reporting FAQs
- Customizing Postman
- Find and Replace
- Purchasing Postman
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Configuring Microsoft AD FS with Postman SSO
- Setting a custom SAML in Azure AD
- Setting up custom SAML in Duo
- Setting up custom SAML in GSuite
- Setting up custom SAML in Okta
- Setting up custom SAML in Onelogin
- Setting up custom SAML in Ping Identity
- Intro to Integrations
- Custom Webhooks
- Microsoft Flow
- Microsoft Teams
- Publishing API documentation
Validating Requests Against Schema
Postman can validate your requests against a linked API schema. This helps keep your documentation, tests, and other linked resources in sync with your API specification. If a request doesn't conform to the schema, you can see a list of issues, and fix them as you go.
This feature is available from Postman 7.15.0 and for OpenAPI 3.0 schemas only at this time.
This section outlines the following topics:
If you want your requests to be validated, your collection must be linked to an API.
Postman will validate a request when it is sent. If issues are found, you will see a warning message showing the number of issues next to the name of the request.
Validation is version-specific, and will be performed against the schema of the particular version of the API linked with the collection. If one version of a collection is linked to more than one version of an API, Postman will select the schema from the latest created version of API for validation.
To access more information about the issues, click the warning message next to the name of the request (e.g. 1 issue). This will open a side-panel on the right indicating detailed information about which component of the request is affected and what the issue itself is.
The Schema validation panel displays the following resources:
- A direct link to the API against which the request is validated—click the link to open the API within the Postman app.
- More details on where the issue lies within the request. Check out the complete list of possible issues.
You can click a specific issue to access the relevant request component.
This section lists each type of issue that validation may raise along with examples. Issues fall into five categories:
Invalid type issues occur when the basic type doesn't match, or when the basic type matches but the schema is wrong.
The path variable "petId" needs to be of type integer, but we found
Missing in schema issues occur when an entity (variable, header, response headers) is not found in the schema you are validating against.
The header "isItCooper" was not found in the schema
Missing in request issues occur when an entity (variable, header) is missing from the request.
The required path variable "name" was not found in the transaction
Invalid body issues occur when the request body didn't match the one specified in the schema.
Body schema not found issues occur when no
application/json schema was found for the response.
Your issue summary helps you keep your requests in sync with your schema.