---
id: restinstance
version: "1.8.0"
license: LGPLv3
license_treatment: copyleft
maintenance: active
---

# RESTinstance — Robot Framework library for RESTful JSON APIs

License: copyleft · Maintenance: active · Downloads: 84.2K/mo

## What it is and what it does

RESTinstance bridges Robot Framework and REST API testing by providing keywords that let you write API tests in plain language rather than code. You make HTTP requests (GET, POST, PUT, PATCH, DELETE), then validate responses using assertions tied to JSON types and paths—no custom validation logic needed. The library automatically generates JSON Schema from your requests and responses, which you can refine through tests and export to file or extend into a full OpenAPI spec. This schema-first approach reduces test maintenance when API response values change, because tests focus on type and structure rather than hardcoded values.

The library depends on established tools: requests for HTTP, jsonschema and openapi-core for validation, GenSON for schema generation, and jsonpath-ng for querying nested JSON. It supports JSON Schema Draft 2020-12 and 2019-09, and OpenAPI 3.0, 3.1, and 3.2. Robot Framework's language-agnostic syntax means tests can be written and maintained by non-programmers, making it suitable for teams where QA and developers have different skill levels.

Use it for:

- Write API contract tests in plain language without programming, using Robot Framework's keyword-driven syntax to validate endpoints.
- Auto-generate and refine JSON Schema from test runs, then export it as a reusable spec or extend it to OpenAPI for documentation.
- Test multiple HTTP methods (GET, POST, PUT, PATCH, DELETE) against the same endpoint and verify both status codes and response structure.
- Query nested JSON responses using JSONPath to assert on specific fields across multiple objects in a single test step.
- Validate API responses against an existing OpenAPI spec to ensure the implementation matches the contract.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

RESTinstance is a Robot Framework library that lets you write API tests in plain language, validating JSON responses against schemas and OpenAPI specifications without requiring programming expertise.

Yes. RESTinstance is actively maintained, has low install friction, and fills a clear niche: API testing in Robot Framework without programming. The copyleft license is not a barrier for internal testing. Choose it if your team uses Robot Framework or prefers keyword-driven test syntax; avoid it if you need a Python-native test library or are already invested in pytest or another framework.

## Install

pip install restinstance
uv add restinstance
poetry add restinstance

## Installing RESTinstance

Before you install: Low install friction with a pure Python wheel distribution. The package is actively maintained with recent commits and supports current Python versions (3.11–3.14). Twelve runtime dependencies are all well-established libraries (requests, jsonschema, openapi-core, etc.), so dependency resolution is straightforward.

License in practice: Licensed under LGPLv3 (copyleft). If you distribute software that uses RESTinstance, you must make your own source code available under a compatible license. For internal testing use, this poses no constraint.

Quickstart:

pip install RESTinstance

# In a Robot Framework test file:
*** Settings ***
Library    REST    https://api.example.com

*** Test Cases ***
Test API
    GET    /endpoint
    Integer    response status    200

Requires Robot Framework to be installed separately and Python 3.11 or later. Tests are written in Robot Framework's .robot syntax, not Python.

Verify before relying:

- Whether the package's JSON Schema generation feature remains accurate as APIs evolve in production use.
- Performance characteristics when testing large JSON payloads or high-volume request sequences.

## Package facts

- License: LGPLv3 (copyleft)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 84.2K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

robot framework api testing, json schema validation testing, openapi test automation, restful api test library, robot framework rest testing, json api test keywords, automated api testing framework, robot-framework, api-testing, json-schema

[View on SkillFed](https://skillfed.io/packages/restinstance) · [View on PyPI](https://pypi.org/project/restinstance/)