restinstance

library1.8.0pypypiunverified

RESTinstance is a Robot Framework library for testing RESTful JSON APIs. It provides keywords for GET, POST, PUT, PATCH, DELETE and supports JSON schema validation. Currently at version 1.8.0, released periodically with compatible changes.

testing http-networking serialization

pip install robotframework-restinstance

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · RESTINSTANCE

restinstance

testingpythonv1.8.0

Install

—

Import

—

Disk

—

Pass rate

0/ 10

Env Coverage0 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v? · pip install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

build_error

glibc

py 3.10–3.95 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

RESTinstance

✓ from RESTinstance import RESTinstance

The library name in Python is 'RESTinstance' (capital R, E, S, T). Import like any Python module.

Minimal example: initialize RESTinstance and perform GET/POST requests. Note: RESTinstance methods return requests.Response objects.

from RESTinstance import RESTinstance import json # Initialize the library api = RESTinstance() # Example: GET request response = api.get('https://jsonplaceholder.typicode.com/posts/1', None) print(response.status_code) print(json.dumps(response.json(), indent=2)) # Example: POST request body = '{"title": "foo", "body": "bar", "userId": 1}' response = api.post('https://jsonplaceholder.typicode.com/posts', body, None) print(response.status_code)

Debug

Known issues

gotchaRESTinstance is designed for Robot Framework, not for standalone Python tests. Using it outside Robot Framework may lead to unexpected behavior (e.g., missing 'output_dir' or logging).

fix

Use requests library directly for standalone Python API testing, or use within Robot Framework tests.

affects: all

gotchaThe library automatically validates responses if a schema is provided. If you set 'schema' in the keyword arguments, but the schema file path is wrong or the schema is invalid, the library raises an exception. This can be confusing if you expect no validation.

fix

Ensure schema files exist and are valid JSON Schema. If you don't need schema validation, omit the 'schema' parameter.

affects: 1.0+

deprecatedIn version 1.8.0, use of `post`, `put`, `patch`, `delete` keywords with `body` as a string (JSON string) is required. Passing a Python dict may cause serialization issues in future versions.

fix

Always pass body as a JSON string (e.g., json.dumps(dict)) or use the `json` parameter if available (check docs).

affects: 1.8.0

gotchaThe library verifies SSL certificates by default. If you are testing against a local development server with self-signed certificates, the request will fail.

fix

Pass `verify=False` in the keyword arguments (e.g., `api.get(url, None, verify=False)`).

affects: all

Upgrade

Version history

1.8.0latest on PyPI · released Apr 6, 2026

Audit

Dependencies

robotframeworkrequiredRESTinstance is a Robot Framework library, requires robotframework to run.

Agent activity

13 hits · last 30 days

node

Resources

githubhttps://github.com/asyrjasalo/RESTinstance ↗

packagehttps://pypi.org/project/restinstance/ ↗

homepagehttps://pypi.org/project/RESTinstance ↗

docshttps://asyrjasalo.github.io/RESTinstance ↗