📚 Documentation

Get Started in Minutes

Everything you need to know to start generating automated tests

🚀 Quick Start Guide

1. Create an Account

Sign up for a free account at QAFactory.tech

# Or use the CLI to authenticate
qafactory auth login --email your@email.com

2. Upload Documentation

Upload your PRD, API spec, or use case documents

# Via CLI
qafactory upload --file api-spec.yaml --type openapi

# Or via API
curl -X POST https://api.qafactory.tech/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@api-spec.yaml" \
  -F "type=openapi"

3. Generate Tests

Let AI analyze and generate comprehensive test cases

# Generate test cases
qafactory generate --document-id doc_123 --output testcases.json

# Generate mock data
qafactory mock --schema user-schema.json --count 100

# Generate test scripts
qafactory script --framework cypress --output tests/

4. Export & Run

Export to your preferred format and execute

# Export test cases to Excel
qafactory export --format excel --output testcases.xlsx

# Run generated tests
npm test  # or your test runner command

API Reference

Upload Document

POST
/v1/documents

Upload a PRD, API spec, or use case document for processing.

Generate Tests

POST
/v1/tests/generate

Generate test cases from uploaded documentation.

Create Mocks

POST
/v1/mocks/generate

Generate realistic mock data based on schemas.

Export Scripts

GET
/v1/scripts/export

Export executable test scripts for various frameworks.

Get Coverage

GET
/v1/analytics/coverage

Retrieve test coverage metrics and analytics.

List Documents

GET
/v1/documents

List all uploaded documents and their status.

Integration Guides

🔗 GitHub Actions

Integrate QAFactory with your GitHub CI/CD pipeline

name: QA Tests
on: [push]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: qafactory/action@v1
        with:
          api-key: ${{ secrets.QA_KEY }}
          spec-file: api-spec.yaml

🔗 GitLab CI

Run automated tests on every merge request

test:
  stage: test
  image: qafactory/cli:latest
  script:
    - qafactory generate
    - qafactory script --run
  only:
    - merge_requests

🔗 Jenkins

Add QAFactory to your Jenkins pipeline

pipeline {
  agent any
  stages {
    stage('Generate Tests') {
      steps {
        sh 'qafactory generate'
        sh 'qafactory script --run'
      }
    }
  }
}

Supported Testing Frameworks

🌐
Selenium

Web automation

🌲
Cypress

Modern E2E testing

🎭
Playwright

Cross-browser

📮
Postman

API testing

RestAssured

Java API tests

🃏
Jest/Vitest

Unit testing

Frequently Asked Questions

What file formats are supported?

We support PDF, Markdown, Word documents, JSON, YAML, Swagger/OpenAPI, RAML, Postman collections, and plain text files.

How accurate are the generated tests?

Our AI engine achieves 95%+ accuracy in identifying test scenarios. You can review and customize generated tests before execution.

Can I customize the generated tests?

Yes! All generated tests are fully editable. You can modify test cases, add custom assertions, or adjust mock data as needed.

Is my documentation secure?

Absolutely. We use enterprise-grade encryption (AES-256) for data at rest and TLS 1.3 for data in transit. We're SOC 2 Type II compliant.

What's included in the free trial?

The 14-day free trial includes full access to all features: unlimited document uploads, test generation, mock data, and script exports.

Need More Help?

Our team is here to support you

Contact Support Join Community