api-probe/examples/passing/comprehensive.yaml at main · hemantobora/api-probe · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# Comprehensive probing - all validation keywords
probes:
  # Probe 1: Status validation
  - name: "Status Check"
    type: rest
    endpoint: "https://httpbin.org/status/200"
    validation:
      status: 200

  # Probe 2: Present, Equals, Type validators
  - name: "JSON Response"
    type: rest
    endpoint: "https://httpbin.org/json"
    validation:
      status: 200
      body:
        present:
          - "slideshow"
          - "slideshow.title"
          - "slideshow.slides"
        equals:
          slideshow.title: "Sample Slide Show"
        type:
          slideshow.title: string
          slideshow.slides: array

  # Probe 3: POST with body, output capture
  - name: "Post and Capture"
    type: rest
    endpoint: "https://httpbin.org/post"
    method: POST
    headers:
      Content-Type: "application/json"
    body:
      name: "test-user"
      age: 25
      active: true
    validation:
      status: 200
      headers:
        present:
          - "Content-Type"
        contains:
          Content-Type: "json"
      body:
        present:
          - "json"
          - "json.name"
          - "json.age"
        equals:
          json.name: "test-user"
          json.age: 25
          json.active: true
        type:
          json.name: string
          json.age: integer
          json.active: boolean
    output:
      POSTED_NAME: "json.name"

  # Probe 4: Matches validator (regex)
  - name: "UUID Response"
    type: rest
    endpoint: "https://httpbin.org/uuid"
    validation:
      status: 200
      body:
        present:
          - "uuid"
        matches:
          uuid: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
        type:
          uuid: string

  # Probe 5: Range validator
  - name: "Delay Response"
    type: rest
    endpoint: "https://httpbin.org/delay/1"
    validation:
      status: 200

  # Probe 6: Headers validation
  - name: "Headers Echo"
    type: rest
    endpoint: "https://httpbin.org/headers"
    headers:
      X-Test-Header: "test-value"
    validation:
      status: 200
      body:
        present:
          - "headers"
          - "headers.X-Test-Header"
        equals:
          headers.X-Test-Header: "test-value"

  # Probe 7: Absent validator (security check)
  - name: "No Sensitive Data"
    type: rest
    endpoint: "https://httpbin.org/json"
    validation:
      status: 200
      headers:
        absent:
          - "X-Internal-Token"
          - "X-Debug-Info"
      body:
        absent:
          - "password"
          - "secret_key"