Automated API testing has never been so easy

Latest release:🏹
Continuous Integration:
Issue Discussions: Slack
Mailing List: Mailing List
License: Apache 2.0
LinkedIn: Zerocode

Zerocode Open Source makes it easy to create, change, orchestrate and maintain automated tests with absolute minimum overhead REST, SOAP, Kafka Real Time Data Streams and much more. Tests created in Zerocode Open Source can be easily shared between teams for reviewing, editing, and versioning. The platform incorporates the best feedback and suggestions from the community to make it incredibly powerful, and we’re seeing rapid adoption across the developer/tester community

Quick Links

To get started with Zerocode Open Source and its features, visit

• Zerocode Wiki
• User's guide
• Release frequency

Maven Dependency

• New releases - zerocode-tdd
• Older releases - zerocode-rest-bdd

Introduction

Zerocode Open Source is a lightweight, simple and extensible framework for writing test intentions in a simple JSON or YAML format that facilitates both declarative configuration and automation.

Put simply, Zerocode solves API Development pain points and brings simplicity to API automation. The framework provides a unified solution to manage response validations, target API invocations, load/stress testing and security testing using a simple domain specific languages (DSL) JSON and YAML.

For example, if your REST API URL https://localhost:8080/api/v1/customers/123 with GET method and "Content-Type": "application/json" returns the following payload and a http status code 200(OK) ,

Response:
{
    "id": 123,
    "type": "Premium High Value",
    "addresses": [
        {
            "type":"home",
            "line1":"10 Random St"
        }
    ]
}

then, Zerocode Open Source can be easily used to validate API using as follows:

The beauty here is, we can use the payload/headers structure for validation as it is without any manipulation or use a flat JSON path to skip the hassles of the entire object hierarchies.

Validators

Using YAML

---
url: api/v1/customers/123
method: GET
request:
  headers:
    Content-Type: application/json
retry:
  max: 3
  delay: 1000
validators:
- field: "$.status"
  value: 200
- field: "$.body.type"
  value: Premium Visa
- field: "$.body.addresses[0].line1"
  value: 10 Random St

or

Using JSON

{
  "url": "api/v1/customers/123",
  "method": "GET",
  "request": {
    "headers": {
      "Content-Type": "application/json"
    }
  },
  "retry": {
    "max": 3,
    "delay": 1000
  },
  "validators": [
    {
      "field": "$.status",
      "value": 200
    },
    {
      "field": "$.body.type",
      "value": "Premium Visa"
    },
    {
      "field": "$.body.addresses[0].line1",
      "value": "10 Random St"
    }
  ]
}

Matchers

Using YAML

---
url: api/v1/customers/123
method: GET
request:
  headers:
    Content-Type: application/json
retry:
  max: 3
  delay: 1000
verify:
  status: 200
  headers:
    Content-Type:
    - application/json; charset=utf-8
  body:
    id: 123
    type: Premium Visa
    addresses:
    - type: Billing
      line1: 10 Random St
verifyMode: LENIENT

or

Using JSON

{
  "url": "api/v1/customers/123",
  "method": "GET",
  "request": {
    "headers": {
      "Content-Type": "application/json"
    }
  },
  "retry": {
    "max": 3,
    "delay": 1000
  },
  "verify": {
    "status": 200,
    "headers": {
      "Content-Type" : [ "application/json; charset=utf-8" ]
    },
    "body": {
      "id": 123,
      "type": "Premium Visa",
      "addresses": [
        {
          "type": "Billing",
          "line1": "10 Random St"
        }
      ]
    }    
  },
  "verifyMode": "STRICT"
}

The test can then be run simply by pointing to the above JSON/YAML file from a Junit @Test method.

   @Test
   @Scenario("test_customer_get_api.yml")
   public void getCustomer_happyCase(){
        // No code goes here
   }

The bottom line is that Zerocode Open Source makes automated API testing declarative and simple. If you’d like to learn more, visit the quick-start guide or user's guide to get started testing fast.

Zerocode Open Source is used by many companies such as Vocalink, HSBC, HomeOffice(Gov) and many others to achieve accurate production drop of their microservices. Learn more about Validators Vs Matchers here.

Happy testing!