> For the complete documentation index, see [llms.txt](https://docs.puppetry.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.puppetry.app/testing-techniques/testing-rest-api.md).

# Testing REST API

Nowadays it’s hard to find a web-application, which doesn’t use REST API. That’s an essential part of application functionality that we have to test. Usually REST API calls are covered with integration tests. However, if by some reason, it isn’t done you can still test it with Puppetry.

Let’s put it into practice. Imagine we have a marketplace application, which relies on [Magento API](https://devdocs.magento.com/swagger/index.html).

To start, we check if product information can be retrieved. So we use `page.assertRest` as follows:

![Making GET request and asserting the response](/files/-Lvtv4zUq90kERtqX34a)

Here we assert that call respond with status code 200 (success) and the returned JSON matches the given [JSONPath](https://www.npmjs.com/package/jsonpath).

Now let’s do something more sophisticated. We are going to obtain authentication token.

The application calls `integration/admin/token` to obtain authentication token. So we set `page.assertRest` parameters like that:

![Making POST request and asserting the response](/files/-LvtvG2N3zl6HDEM4VFk)

We expect the response of status 200 with a non-empty access token.

Note that `page.assertRest` automatically assigns the response text to `PUPPETRY_LAST_RESPONSE_TEXT` template variable. So we can use it further in the test case.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.puppetry.app/testing-techniques/testing-rest-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.