rf-requests

RequestsLibrary (API steps)

In rf_repl, import first

The REPL starts with BuiltIn only - Create Session is "not found" until you send Import Library RequestsLibrary (and Import Library Collections), or Import Resource resources/api.resource for project keywords.

Exploring an API without a schema

Without expected_status, a 4xx/5xx raises HTTPError: 422 Client Error ... and the response body (which names the bad field) is NOT in the message. Probe with expected_status=any and log the body:

${r}=    POST On Session    api    /orders    json=${body}    expected_status=any
Log    ${r.status_code} ${r.text}

Every test creates its own data

A test must pass when run alone (rf_run by longname, rerun of failed tests). Never hand ids from one test to the next with Set Suite Variable - "Get Invoice" then fails without "Create Invoice". Put creation in a keyword and call it in each test that needs the record:

Get Invoice Returns Lines
    ${id}=    Create Test Invoice    ACME GmbH
    ${r}=     GET On Session    api    /invoices/${id}

Suite Setup is for what every test only reads (the authenticated session, base data).

Sessions and headers

&{headers}=    Create Dictionary    X-Workshop-Space=${SHOP_SPACE}    X-Session-ID=cart-1
Create Session    shop    ${SHOP_URL}    headers=${headers}

Session headers go with every request; per-request headers=${h} adds to them.

Bodies: pass a dictionary, never JSON text

Write	Result
json={"product_id": 1}	sends the JSON string "{\"product_id\": 1}" - API answers 422 "Input should be a valid dictionary"
headers={"X-Session-ID": "x"}	fails: 'str' object has no attribute 'items'
json=${{ {"product_id": 1, "quantity": 2} }}	dict - correct (inline Python needs the dict braces inside ${{ }})
&{{"k": "v"}}	fails: SyntaxError: invalid syntax (no dict braces inside)
&{body}= Create Dictionary product_id=${7} quantity=${3} then json=${body}	dict with ints - correct
Create Dictionary quantity=3	value is the STRING "3" - use ${3} for numbers, ${True} for booleans