An OpenAPI specification is a machine-readable description of a REST API. It defines every endpoint the API exposes, the request structure each endpoint accepts, the response structure each endpoint returns, valid status codes, authentication requirements, and field-level validation constraints. For test generation, the OpenAPI spec is the single authoritative source of truth for what an API is supposed to do. Rather than relying on a developer's memory of the spec or a natural language description of requirements, Skyramp's tools derive test requirements directly from the formal specification. This ensures that tests validate the API's documented contract rather than assumptions about how the API should behave.

The parser processes a valid OpenAPI 3.0 or Swagger 2.0 specification file and extracts the structured information required to drive test generation across all test types. It extracts endpoint definitions (URL, HTTP method, path parameters, query parameters), request schemas (body structure, field types, required vs optional fields, format constraints like email or UUID), response schemas (expected body structure per status code), authentication schemes (Bearer tokens, Basic auth, OAuth flows, API Key), and server configurations (base URLs, environment-specific overrides). This extracted structure becomes the validated input set that feeds Skyramp's deterministic generation tools, ensuring that all generated tests are derived from the authoritative API definition rather than inferred from incomplete context or developer descriptions.

Skyramp's OpenAPI parser supports OpenAPI 3.0 and Swagger 2.0 specifications. Both JSON and YAML input formats are supported. Specs with $ref definitions (references to external schema files) and multi-file specs (specifications split across multiple files) are fully supported. The parser resolves all references and produces a complete, unified schema representation. If your specification uses advanced features like discriminators, oneOf, or anyOf, the parser handles these correctly and generates appropriate test variations.

The workflow from specification to tests is streamlined and automated. Parse the spec to extract the structured API definition. Review the extracted structure to verify that the parser correctly identified all endpoints and schemas. Select which endpoints to generate tests for based on priority and coverage needs. Choose the test types needed: contract tests for API contract validation, integration tests for multi-step workflows, smoke tests for deployment validation, load tests for performance validation, and fuzz tests for security testing. Generate tests. The parsed spec provides the inputs for all generation tools automatically. Developers do not need to manually specify endpoint URLs, request schemas, or authentication requirements for each test type they generate. The parser makes the spec the single point of entry for the entire test generation workflow.