Getting started | Basic tests from a live server | Going deeper
Package: httptest2 1.2.2.9000
httptest2: Test Helpers for 'httr2'
Testing and documenting code that communicates with remote servers can be painful. This package helps with writing tests for packages that use 'httr2'. It enables testing all of the logic on the R sides of the API without requiring access to the remote service, and it also allows recording real API responses to use as test fixtures. The ability to save responses and load them offline also enables writing vignettes and other dynamic documents that can be distributed without access to a live server.
Authors:
httptest2_1.2.2.9000.tar.gz
httptest2_1.2.2.9000.zip(r-4.7)httptest2_1.2.2.9000.zip(r-4.6)httptest2_1.2.2.9000.zip(r-4.5)
httptest2_1.2.2.9000.tgz(r-4.6-any)httptest2_1.2.2.9000.tgz(r-4.5-any)
httptest2_1.2.2.9000.tar.gz(r-4.7-any)httptest2_1.2.2.9000.tar.gz(r-4.6-any)
httptest2_1.2.2.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
httptest2/json (API)
| # Install 'httptest2' in R: |
| install.packages('httptest2', repos = c('https://nealrichardson.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/nealrichardson/httptest2/issues
Pkgdown/docs site:https://enpiar.com
Last updated from:37efe13ff4. Checks:7 NOTE, 2 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | NOTE | 138 | ||
| source / vignettes | OK | 209 | ||
| linux-release-x86_64 | NOTE | 129 | ||
| macos-release-arm64 | NOTE | 121 | ||
| macos-oldrel-arm64 | NOTE | 91 | ||
| windows-devel | NOTE | 95 | ||
| windows-release | NOTE | 81 | ||
| windows-oldrel | NOTE | 86 | ||
| wasm-release | OK | 141 |
Exports:.mockPathsblock_requestsbuild_mock_urlcapture_requestschange_stateend_vignetteexpect_DELETEexpect_GETexpect_no_requestexpect_PATCHexpect_POSTexpect_PUTexpect_request_headerfind_mock_fileget_current_redactorgsub_responseredact_cookiesredact_headerssave_responseset_redactorstart_capturingstart_vignettestop_capturingstop_mockinguse_httptest2use_mock_apiwith_mock_apiwith_mock_dirwith_tracewithin_body_textwithout_internet
Dependencies:askpassbriocallrclicrayoncurldescdiffobjdigestevaluatefsgluehttr2jsonlitelifecyclemagrittropensslotelpkgbuildpkgloadpraiseprocessxpsR6rappdirsrlangrprojrootsystestthatvctrswaldowithr
httptest: A Test Environment for HTTP Requests in R
Last update: 2025-06-27
Started: 2021-12-29
Redacting and Modifying Recorded Requests
Default: redact standard auth methods | Writing custom redacting functions | Setting a package-level redactor | URL shortening
Last update: 2025-06-27
Started: 2017-10-08
Writing Vignettes with APIs
The basics: start_vignette() | Handling server state changes | Advanced topics
Last update: 2025-06-27
Started: 2018-01-12
Frequently Asked Questions
Where are my mocks recorded? | How do I fix "non-portable file paths"? | Why are mocks stored as text files?
Last update: 2023-07-06
Started: 2020-12-15
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Set an alternate directory for mock API fixtures | .mockPaths |
| Record API responses as mock files | capture_requests start_capturing stop_capturing |
| Handle a change of server state | change_state |
| Test that an HTTP request is made with a header | expect_request_header |
| Expectations for mocked HTTP requests | expect_DELETE expect_GET expect_no_request expect_PATCH expect_POST expect_PUT expect_verb |
| Find and replace within a response object | gsub_response |
| Remove sensitive content from HTTP responses | redact redact_cookies redact_headers within_body_text |
| Set a response redactor | set_redactor |
| Set mocking/capturing state for a vignette | end_vignette start_vignette |
| Use 'httptest2' in your tests | use_httptest2 |
| Serve a mock API from files | stop_mocking use_mock_api with_mock_api |
| Use or create mock files depending on their existence | with_mock_dir |
| Make all HTTP requests raise an error | block_requests without_internet |
