Skip to content

Upload Contracts

Contracts are API schema files that describe your application's endpoints. CaseRunner uses them to build an endpoint catalog — the API equivalent of Page Object Models.

Info

This step applies to API projects only. Web and Mobile projects use Pages Metadata instead.

Supported Formats

Format File Extensions
OpenAPI / Swagger .json, .yaml, .yml
WSDL .wsdl
XSD .xsd
Postman Collection .json
Archive .zip (containing any of the above)

Steps

  1. Open your project and navigate to the Contracts tab.
  2. Upload your API schema file by either:
    • Dragging and dropping the file onto the upload area
    • Clicking to browse and choose the file
  3. Wait for the upload and extraction to complete.

Info

CaseRunner automatically detects the contract type based on the file extension and extracts a structured endpoint catalog. This may take a few moments depending on the schema size.

After Upload

Once extraction is complete, you can review the endpoint catalog extracted from your schema. Each endpoint includes:

  • HTTP method and path
  • Summary / description
  • Request body schema
  • Success and error response schemas

You can upload multiple schema files to a single project if your API spans multiple contracts.

Next Step

Generate Test Cases using the extracted features and endpoint catalog.