RESTinstance
Robot Framework library for RESTful JSON APIs
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Robot Framework to be installed separately and Python 3.11 or later.
- Tests are written in Robot Framework's .robot syntax, not Python.
- Low install friction with a pure Python wheel distribution.
License · maintenance · safety
LGPLv3 (copyleft) — 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.
last release 2026-04-06 (130 days) · last repo commit 2026-07-14 · 220 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 84,190 downloads/mo, #14,020 on PyPI
Alternatives
Verify before relying
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- 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.
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 on this page. Verify before relying on it.
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
restinstance on PyPI
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.
Requires Robot Framework to be installed separately and Python 3.11 or later. Tests are written in Robot Framework's .robot syntax, not Python.
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 200Verify 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 the current Python release >=3.11 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 12 packagesdocutilsflexGenSONjsonpath-ngjsonschemaopenapi-corepygmentspytzrequestsrobotframeworktzlocalsetuptools |
| Maintenance | Actively maintained 130 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 84,190 / month, #14,020 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: Robot FrameworkFramework :: Robot Framework :: LibraryLicense :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)Operating System :: OS IndependentProgramming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: Software Development :: Libraries :: Python ModulesTopic :: Software Development :: Testing |
Evidence: restinstance-1.8.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “restful api test library”
- RESTinstanceRESTinstance is a Robot Framework library that lets you write API…
- restflyRESTfly is a framework for building libraries that interact with…
- twentyc.rpcA client library for consuming 20c's RESTful API, built on top of the…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also robotframework-requests · robotframework-jsonlibrary · robotframework · robotframework-seleniumlibrary · robotframework-assertion-engine · robotframework-appiumlibrary · robotframework-selenium2library · robotframework-faker · robotframework-seleniumtestability