2026-02-10 –, A deepdive into OpenApiTools
OpenApiTools v1.0 introduced a CLI tools to easily generate a Robot Framework library based on an OpenAPI specification, a library with keywords for all endpoints of the target API. Keywords that automatically generate the required data, so no more need to specify all the request data for each request you want to make in your tests. Of course there's options to override specific values and ways to control the generated values.
In this workshop we'll dive into OpenApiTools; we'll generate our custom library to test our API and we'll look into tweaking / tuning it to our liking.
In addition to working with the generated library, we'll dig into the other libraries that are part of OpenApiTools, OpenApiLibCore and OpenApiDriver. We'll look at their keywords and their use cases and how they all fit together. And the session wouldn't be a deepdive if we wouldn't get into advanced usage of all these libraries by leveraging the mappings file (what it is, how to write it and what you can do with it).
A demo project will be available for the exercises during the workshop, but bringing your actual repo / project / OpenAPI spec and using that for the exercises is encouraged.
Lessons Learned:
The participants should be able to apply the learning for the workshop in their project, allowing them to generate a keyword library for their target API and set up any required constraint mappings. The participant will also learn how the generated library relates to OpenApiLibCore and OpenApiDriver and the keywords those libraries offer, allowing the participant to effectively use all the tools in OpenApiTools to validate their target API.
Preparation and Technical Requirements
- GIT installed: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- A GitHub account: https://github.com/
This allows you to fork the repo and do the exercises.
The repo that will be shared for this workshop contains a (VS Code) devcontainer configuration based on Docker. In order to use this devcontainer you'll need:
- Docker installed, for example using Docker Desktop: https://docs.docker.com/desktop/
- Visual Studio Code installed: https://code.visualstudio.com/download
- The devcontainer plugin for VS Code: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers. Within VS Code, you can search for the Dev Containers plugin to install it directly from within VS Code.
The devcontainer contains everything needed to run the workshop exercises.
If for some reason you cannot run devcontainers, please contact me before the workshop so we can work out a setup that will work for your situation.
How to use the different tools and libraries in OpenApiTools to test an API
Categorize / Tags:API-testing, OpenAPI, OAS, OpenApiTools, OpenApiDriver, OpenApiLibCore
Is this suitable for ..?: Intermediate RF User, Advanced RF User Describe your intended audience:Automation engineers with some experience with testing (HTTP) APIs using e.g. RequestsLibrary or tools like Swagger UI. Some entry-level Python knowledge / experience or the willingness to learn a bit of Python will allow the candidate to get most out of the workshop.
In-Person or Online talk/workshop?:In-Person
Robin is an experienced Robot Framework and Python developer who helps teams / organizations taking the next steps in the area of automation and code quality.
He is the author / maintainer of robotframework-openapitools and a RoboCon regular. The past years he has been speaker and workshop facilitator at RoboCon and other meetups, focused on API testing, repo structure & architecture and Keyword distribution & sharing within organizations.