Step CI · Example Payload

Step Ci Rest Workflow Example

Example Step CI YAML workflow for testing a REST API with authentication and response validation

API TestingFunctional TestingTestingCI/CDQuality AssuranceAutomationOpen Source

Step Ci Rest Workflow Example is an example object payload from Step CI, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionformatcontent

Example Payload

{
  "title": "Step CI REST API Test Workflow",
  "description": "Example Step CI YAML workflow for testing a REST API with authentication and response validation",
  "format": "yaml",
  "content": "version: '1.1'\nname: REST API Tests\nenv:\n  BASE_URL: https://api.example.com\n  API_KEY: ${{secrets.API_KEY}}\nconfig:\n  http:\n    baseURL: ${{env.BASE_URL}}\ntests:\n  create-and-retrieve-item:\n    name: Create and Retrieve Item\n    steps:\n      - name: Create Item\n        http:\n          url: /items\n          method: POST\n          headers:\n            Authorization: Bearer ${{env.API_KEY}}\n            Content-Type: application/json\n          body:\n            name: Test Item\n            description: Created by Step CI\n          check:\n            status: 201\n            schema:\n              type: object\n              properties:\n                id:\n                  type: string\n                name:\n                  type: string\n          captures:\n            item_id:\n              jsonpath: $.id\n      - name: Retrieve Item\n        http:\n          url: /items/${{captures.item_id}}\n          method: GET\n          headers:\n            Authorization: Bearer ${{env.API_KEY}}\n          check:\n            status: 200\n            jsonpath:\n              $.name: Test Item\n            performance:\n              firstByte:\n                lte: 500\n"
}