Validate an API specification

As you edit your specification, Postman identifies syntax errors, such as wrong data types and nesting, and shows details about the errors so you can correct them. Postman also identifies API governance issues in OpenAPI 3.0 specifications based on the rules configured for your team.

View syntax errors in your specification

Postman automatically identifies syntax errors as you edit your API specification. Errors can include missing fields, malformed field names, wrong data types, wrong nesting, or other issues. For Postman to be able to check your specification elements, you must use valid JSON or YAML.

To view any syntax errors, select issues in specification. Each syntax error shows the line on which it occurs, the severity, the type as Syntax, and details about the issue. Select a column header to sort the results in ascending or descending order.

Select the line number to highlight it in the specification. You can also get details about the issue by hovering over the error in the specification.

Sometimes a single error in your specification can cause more than one issue to appear in the list. As you fix the errors, the issues disappear.

View rule violations in your specification

API governance rule validation is available with Postman Enterprise plans.

As you edit your OpenAPI 3.0 specification, Postman automatically checks it against the Postman API Governance rules configured for your team. Postman displays rule violations below the editor.

To view any governance rule violations, select issues in specification. Each rule violation shows the line on which it occurs, the severity, the type as Governance, and details about the issue. Select a column header to sort the results in ascending or descending order.

Select the line number to highlight it in the specification. You can also get details about the issue by hovering over the violation in the specification.