Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Robot Framework keyword library wrapper for requests

branch: master

Build Status PyPi downloads

RequestsLibrary is a Robot Framework test library that uses the Requests HTTP client.


Install robotframework-requests via pip

pip install -U robotframework-requests

Here is a sample test case.

Library Collections
Library RequestsLibrary
Test Cases
Get Requests
Create Session github
Create Session google
${resp}= Get google /
Should Be Equal As Strings ${resp.status_code} 200
${resp}= Get github /users/bulkan
Should Be Equal As Strings ${resp.status_code} 200
${jsondata}= To JSON ${resp.content}
Dictionary Should Contain Value ${jsondata} Bulkan Savun Evcimen

RequestsLibrary, tries to follow the same API as requests. In the above example we load in the RequestsLibrary using the Library keyword. To be able to distinguish HTTP requests to different hosts and for ease of creation of test cases, you need to create a Session. Internally this will create a request.Session object. The Create Session keyword accepts two arguments;

* _alias_ to identify the session later
* _root url_ to the server

HTTP verbs are mapped keywords which accept two arguments.

* _alias_ identifying the Session we created earlier. 
* _URI_  to send the request to.

Above we create two Sessions one to the github api and the other to google. Creating sessions dont send any requests.

After we create a Session we can send any of the following Get, Post, Put, Delete, Head requests. In the above example we send a GET request to the session with the alias google and check the HTTP response code. Then send a another GET request but this time to the session with the alias github and pass in a uri. In this case it is /users/bulkan which will return a JSON string. RequestsLibrary provide a convenience keyword for loading in a JSON string called To JSON.

For more examples see the tests folder which contains testcase files that is used to test the keywords in this library againts


For individual keyword documentation see the following;


Send your questions to the Robot Framework Users Group

Follow me on twitter - @bulkanevcimen

Something went wrong with that request. Please try again.