Postman's New Schema Validation Feature Helps Encourage API Spec Literacy

Postman, an API development platform provider, has announced that its API Builder is gaining the ability to validate API schemas in real-time via a new UI pane that is accessible in the tool’s define tab. The addition of this functionality helps to provide developers with real-time feedback and encourage API specification literacy.

At the time of the announcement Postman’s schema validation functionality is only supported for OpenAPI 3.0, although Kin Lane, Postman’s Chief Evangelist noted to ProgrammableWeb that the company intends to “support all of the leading API specifications equally when it comes to autocomplete, validation, and other design-time features.”

While editing OpenAPI definitions in Postman users will now notice a small banner across the bottom of the define panel that either states “Schema validated” or lists the number of errors that were found. This information updates in real-time and users can click on the banner to expand the UI and dive into the specifics of the errors that were found. The feature is speedy, usually updating to display errors within a few seconds and provides useful information for identifying the error made.

The most straightforward benefits of this new tool are obvious, identifying errors in real-time is certain to improve development speed and accuracy on the platform. When ProgrammableWeb asked Lane about other, less obvious benefits provided by this feature he noted that:

“OpenAPI literacy to help educate developers about the finer details of the specification, as well as helping speed up their design processes.” Lane continued by noting that there is additional value in, “Providing a feedback loop around not just the APIs, but how OpenAPI is being applied (or not), gathering data, and feeding back to the OAI to inform the road map for the specification.”

This new Schema Validation functionality is available now in Postman v7.29’s API Builder. 

Be sure to read the next API Design article: Understanding the Essentials of gRPC