Portman generates and executes Postman collections from an OpenAPI definition, checking whether an implemented API conforms to its published schema. It suits external or public APIs where consumer-driven contract tests are unavailable and can run in CI/CD pipelines. section 7.4.2 section 7.8
A typical Portman workflow is:
- Define the OpenAPI file, generated collection name, environment variables, and server URL in a CLI options file. section 7.4.2
- Configure contract tests for operations, such as successful status codes, schema validation, content type, JSON bodies, and required headers. section 7.4.2
- Generate the collection, optionally include Portman tests, and execute it with Portman’s embedded Newman runner. section 7.4.2
- Inspect each operation’s result and use failures to identify mismatches between implementation responses and the OpenAPI definition. section 7.4.2
Product Catalog API check
Running Portman against a local Product Catalog API produces a collection report for a GET product-details operation. A passing run records a 2xx status, valid schema, application/json content type, and a JSON response body, followed by “Collection run completed.”
