Json Schema Assertion

*JSON Schema Assertion: This feature allows you to create schema tests for your API response. By providing your API response, you can generate tests using either SDKs or REST APIs.

Usage 🚀

Refer to Setup Guide for installing dependecies for both Java and Python.

JAVA

There are 2 clients available with the Java SDK: SyncClient and AsyncClient

Java Client Code

# for async client 
import org.qyrus.ai_sdk.Clients.AsyncClient;
AsyncClient client = new AsyncClient(<API_TOKEN>, null);

# for sync client
import org.qyrus.ai_sdk.Clients.SyncClient;
SyncClient client = new SyncClient(<API_TOKEN>, null);

Using SyncClient

Here's an example of utilizing JSON Schema Assertion with SyncClient.

Java SyncClient Code

private static void testJSONSchemaAssertions() {
        Dotenv dotenv = Dotenv.load();
        String QYRUS_AI_SDK_API_TOKEN = dotenv.get("QYRUS_AI_SDK_API_TOKEN");

        SyncClient client = new SyncClient(QYRUS_AI_SDK_API_TOKEN, null);
        Map<String, Object> loanApplication = Map.of(
                "loanId", 101,
                "userId", 1,
                "loanAmount", 200000,
                "loanTerm", 30,
                "propertyValue", 250000,
                "income", 100000,
                "creditScore", 750,
                "status", "pending"
            );

        long startTime = System.currentTimeMillis();
        int numberOfRequests = 2;

        for (int i = 0; i < numberOfRequests; i++) {
            try {
                // Assuming that the client has a method for JSON schema assertions
                JSONSchemaAssertion.JsonSchemaResponse response = client.api_assertions.jsonschema.create(loanApplication);

                // Process and print JSON schema properties and required fields
                System.out.println("Schema: " + response.getSchema());
                response.getProperties().forEach((key, property) ->
                    System.out.println("Field: " + key + ", Type: " + property.getType())
                ); 
                System.out.println("Required fields: " + String.join(", ", response.getRequired()));

            } catch (Exception e) {
                e.printStackTrace();
            }
        }

        long endTime = System.currentTimeMillis();
        System.out.println("Synchronous Total time for JSON Schema Assertion request: " + (endTime - startTime) + " ms");
    }

Using AsyncClient

Here's an example of utilizing JSON Schema Assertion with AsyncClient.

Java AsyncClient Code

private static void asyncTestJSONSchemaAssertions() {
        Dotenv dotenv = Dotenv.load();
        String QYRUS_AI_SDK_API_TOKEN = dotenv.get("QYRUS_AI_SDK_API_TOKEN");
        
        AsyncClient client = new AsyncClient(QYRUS_AI_SDK_API_TOKEN, null);
        Map<String, Object> loanApplication = Map.of(
                "loanId", 101,
                "userId", 1,
                "loanAmount", 200000,
                "loanTerm", 30,
                "propertyValue", 250000,
                "income", 100000,
                "creditScore", 750,
                "status", "pending"
            );

        long startTime = System.currentTimeMillis();
        int numberOfRequests = 2;
        List<CompletableFuture<AsyncJSONSchemaAssertion.JsonSchemaResponse>> futures = new ArrayList<>();

        for (int i = 0; i < numberOfRequests; i++) {
            CompletableFuture<AsyncJSONSchemaAssertion.JsonSchemaResponse> responseFuture =
                client.api_assertions.jsonschema.create(loanApplication);

            responseFuture.thenAccept(response -> {
                // Process and print JSON schema properties and required fields
                System.out.println("Schema: " + response.getSchema());
                response.getProperties().forEach((key, property) ->
                    System.out.println("Field: " + key + ", Type: " + property.getType())
                );
                System.out.println("Required fields: " + String.join(", ", response.getRequired()));
            }).exceptionally(ex -> {
                System.out.println("An error occurred: " + ex.getMessage());
                ex.printStackTrace();
                return null;
            });

            futures.add(responseFuture);
        }

        CompletableFuture.allOf(futures.toArray(new CompletableFuture[0])).join();
        long endTime = System.currentTimeMillis();
        System.out.println("Asynchronous total time for JSON Schema Assertion: " + (endTime - startTime) + " ms");
    }

---

PYTHON

There are two clients available with the Python SDK: SyncQyrusAI and AsyncQyrusAI.

Python Client Code

# for sync client
from qyrusai import SyncQyrusAI
client = SyncQyrusAI(api_key=QYRUS_API_TOKEN)

# for async client
from qyrusai import AsyncQyrusAI
client = AsyncQyrusAI(api_key=QYRUS_API_TOKEN)

Using SyncQyrusAI

Here's an example of utilizing JSON Schema Assertion with SyncQyrusAI.

Python SyncQyrusAI Code

import os
import json
from qyrusai import SyncQyrusAI

QYRUS_API_TOKEN = os.environ.get("QYRUS_API_TOKEN")

client = SyncQyrusAI(api_key=QYRUS_API_TOKEN)

# response_body : Provide the data for generating json path assertions.
response_body = {
    "ok": True,
    "message": "fetched teams",
    "teams": [
        {
            "id": 2039,
            "team_name": "CTC - STG Common Area",
            "organization_id": 1867,
            "team_desc": "Testing w.r.t the teams requirement during development & bug fixes",
            "created_date": "2020-05-07 06:21:20",
            "team_status": True,
            "uuid": "9373c501b048481b9525a7d06d11146d",
            "created_by": "[email protected]",
            "modified_date": "None",
            "modified_by": None,
            "organization_name": "CTC Quinnox"
        },
        {
            "id": 3574,
            "team_name": "Qyrus Walkthrough - New",
            "organization_id": 1867,
            "team_desc": "Qyrus Walkthrough",
            "created_date": "2022-12-07 07:46:06",
            "team_status": True,
            "uuid": "292fa590a34d4556b306dda8e4a4dc2d",
            "created_by": "[email protected]",
            "modified_date": "None",
            "modified_by": None,
            "organization_name": "ctcquinnox"
        }
    ]
}
op = op = client.api_assertions.jsonschema.create(response_body)
print(json.dumps(op, indent=4))

Using AsyncQyrusAI

Here's an example of utilizing JSON Schema Assertion with AsyncQyrusAI.

Python AsyncQyrusAI Code

import os
import json

import asyncio
from qyrusai import AsyncQyrusAI

QYRUS_API_TOKEN = os.environ.get("QYRUS_API_TOKEN")

client = AsyncQyrusAI(api_key=QYRUS_API_TOKEN)

response_body = {
    "ok": True,
    "message": "fetched teams",
    "teams": [
        {
            "id": 2039,
            "team_name": "CTC - STG Common Area",
            "organization_id": 1867,
            "team_desc": "Testing w.r.t the teams requirement during development & bug fixes",
            "created_date": "2020-05-07 06:21:20",
            "team_status": True,
            "uuid": "9373c501b048481b9525a7d06d11146d",
            "created_by": "[email protected]",
            "modified_date": "None",
            "modified_by": None,
            "organization_name": "CTC Quinnox"
        },
        {
            "id": 3574,
            "team_name": "Qyrus Walkthrough - New",
            "organization_id": 1867,
            "team_desc": "Qyrus Walkthrough",
            "created_date": "2022-12-07 07:46:06",
            "team_status": True,
            "uuid": "292fa590a34d4556b306dda8e4a4dc2d",
            "created_by": "[email protected]",
            "modified_date": "None",
            "modified_by": None,
            "organization_name": "ctcquinnox"
        }
    ]
}
async def main():
    op = await client.api_assertions.jsonschema.create(response_body)
    print(json.dumps(op, indent=4))

# Run the async function
asyncio.run(main())

---

REST APIs

This API allows users to create test based on provided API JSON Schema.

• Endpoint

  • URL : POST {{GATEWAY_URL}}/api-assertion-gpt-sdk/v1/api/assertion/jsonschema

• Headers

  • Authorization: [Your Authorization Token]

  • Custom: [Your Custom Header Value]

• Request Body: { "response": { "loanId": 101, "userId": 1, "loanAmount": 200000, "loanTerm": 30, "propertyValue": 250000, "income": 100000, "creditScore": 750, "status": "pending" } }

• Response: