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

step-ci-rest-workflow-example.json Raw ↑
{
  "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"
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/step-ci-rest-workflow-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.