k6 REST and WS API Play

A simple REST and Websocket service designed for experimentation with k6. It contains various authentication mechanisms, both private and public, and includes both HTTP and Websocket endpoints.

You can access this service at https://test-api.k6.io/

The k6_tests folder includes a few k6 examples for this service.

Set up your local development environment

You can also deploy this service on your local machine or infrastructure. Using docker-compose:

docker-compose up -d

You should now be able to access it at http://localhost:8000/

By default, the data is stored in a local SQLite database.

Using python and pip

Alternatively, you can set up the project using python and pip:

cd test-api.k6.io
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

You will likely need to install some dependencies not installed in your system. For example:

sudo apt install libmysqlclient-dev  # debian/ubuntu
pip install wheel

Once you have set up all the project dependencies, configure the database:

python project/manage.py makemigrations && python project/manage.py migrate

Load fixture with initial data to populate the database with some users and crocodiles:

python project/manage.py loaddata project/fixtures/initial.json

# user: admin/test123!
# user: user/test123!

Run django server:

ENVIRONMENT_NAME=dev python project/manage.py runserver

You should now be able to access it at http://localhost:8000.

Browseable API

Nice feature of this project is that APIs are "browseable", and can be easily explored by developers via the web interface.

Explore this by clicking on one of the endpoints, for example /public/crocodiles/ and login (top right corner) with one of the default users.