GripMock

Appearance

JSON Schema for Stubs ​

Ever wondered if your stub definitions are correct? GripMock's JSON Schema is here to help! It's like having a spell-checker for your stub files - it catches errors before they cause problems and gives you helpful hints as you write.

Overview ​

You can find the JSON Schema at: https://bavix.github.io/gripmock/schema/stub.json

Think of this schema as your stub definition rulebook. It covers everything you might want to do:

  • ✅ Single stub objects (the basics)
  • ✅ Arrays of stubs (when you need multiple responses)
  • ✅ All input matching strategies (equals, contains, matches)
  • ✅ Header matching (for authentication and metadata)
  • ✅ Streaming responses (for real-time data)
  • ✅ Delays and error responses (for realistic testing)
  • ✅ Priority system (for complex routing logic)

Usage ​

In YAML Files ​

Add this line to the top of your YAML stub files:

yaml
# yaml-language-server: $schema=https://bavix.github.io/gripmock/schema/stub.json

service: MyService
method: MyMethod
output:
  data:
    result: success

In JSON Files ​

Add this to your JSON stub files:

json
{
  "$schema": "https://bavix.github.io/gripmock/schema/stub.json",
  "service": "MyService",
  "method": "MyMethod",
  "output": {
    "data": {
      "result": "success"
    }
  }
}

IDE Support ​

The best part? Your favorite IDE probably already supports this! Here's how to get it working:

VS Code ​

  1. Install the "YAML" extension (if you haven't already)
  2. Add the schema reference to your files (see examples above)
  3. Enjoy real-time validation and helpful auto-completion

Validation ​

Command Line ​

bash
# Validate JSON files
python -m json.tool your-stubs.json

# Validate with schema (requires jsonschema package)
pip install jsonschema
jsonschema -i your-stubs.json https://bavix.github.io/gripmock/schema/stub.json

CI/CD Integration ​

yaml
# GitHub Actions example
- name: Validate Stubs
  run: |
    pip install jsonschema
    jsonschema -i stubs.json https://bavix.github.io/gripmock/schema/stub.json

Schema Features ​

Priority ​

yaml
priority: 100  # Higher numbers = higher priority (default: 0)

Input Matching ​

yaml
input:
  ignoreArrayOrder: true  # Optional: disable array order checks
  equals:                 # Exact match
    name: "test"
    id: 123
  contains:               # Partial match
    description: "test"
  matches:                # Regex match
    email: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"

Header Matching ​

yaml
headers:
  equals:                 # Exact match
    authorization: "Bearer token123"
  contains:               # Partial match
    user-agent: "Mozilla"
  matches:                # Regex match
    x-version: "v\\d+"

Output Configuration ​

yaml
output:
  delay: "100ms"          # Optional delay
  data:                   # Response data
    message: "Hello"
    code: 200
  error: "Error message"  # Error response
  code: 14               # gRPC status code
  headers:               # Response headers
    x-request-id: "123"
  stream:                # Streaming response
    - message: "First"
    - message: "Second"

Examples ​

Simple Stub ​

yaml
# yaml-language-server: $schema=https://bavix.github.io/gripmock/schema/stub.json

service: Greeter
method: SayHello
priority: 100
input:
  equals:
    name: "world"
output:
  data:
    message: "Hello, world!"

Multiple Stubs ​

yaml
# yaml-language-server: $schema=https://bavix.github.io/gripmock/schema/stub.json

- service: Greeter
  method: SayHello
  input:
    equals:
      name: "Alice"
  output:
    data:
      message: "Hello, Alice!"

- service: Greeter
  method: SayHello
  input:
    equals:
      name: "Bob"
  output:
    data:
      message: "Hello, Bob!"

Streaming Response ​

yaml
# yaml-language-server: $schema=https://bavix.github.io/gripmock/schema/stub.json

service: StreamService
method: StreamData
output:
  delay: "200ms"
  stream:
    - id: 1
      data: "First message"
    - id: 2
      data: "Second message"

Error Response ​

yaml
# yaml-language-server: $schema=https://bavix.github.io/gripmock/schema/stub.json

service: ErrorService
method: SimulateError
output:
  delay: "500ms"
  error: "Service temporarily unavailable"
  code: 14  # UNAVAILABLE

Why Use the Schema? ​

Here's what you get when you use our JSON Schema:

  • Consistency: Everyone on your team writes stubs the same way
  • Quality: Catch typos and errors before they break your tests
  • Productivity: Auto-completion means you write faster and make fewer mistakes
  • Documentation: Hover over any field to see what it does
  • Team Collaboration: New team members can understand your stubs immediately