@jaredwray/mockhttp 1.9.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/README.md +40 -8
  2. package/dist/index.d.mts +90 -11
  3. package/dist/index.mjs +203 -240
  4. package/package.json +17 -13
  5. package/site/dist/api/index.html +17983 -0
  6. package/site/dist/api/swagger.json +5487 -0
  7. package/site/dist/changelog/index.html +784 -0
  8. package/site/dist/changelog/page/2/index.html +577 -0
  9. package/site/dist/changelog/v0-2-0/index.html +437 -0
  10. package/site/dist/changelog/v0-2-1/index.html +438 -0
  11. package/site/dist/changelog/v0-2-2/index.html +436 -0
  12. package/site/dist/changelog/v0-2-3/index.html +440 -0
  13. package/site/dist/changelog/v0-3-0/index.html +443 -0
  14. package/site/dist/changelog/v0-4-0/index.html +437 -0
  15. package/site/dist/changelog/v0-4-1/index.html +441 -0
  16. package/site/dist/changelog/v0-4-2/index.html +446 -0
  17. package/site/dist/changelog/v0-4-3/index.html +437 -0
  18. package/site/dist/changelog/v0-5-0/index.html +443 -0
  19. package/site/dist/changelog/v0-6-0/index.html +444 -0
  20. package/site/dist/changelog/v0-6-1/index.html +441 -0
  21. package/site/dist/changelog/v0-7-0/index.html +445 -0
  22. package/site/dist/changelog/v0-8-0/index.html +440 -0
  23. package/site/dist/changelog/v0-9-0/index.html +437 -0
  24. package/site/dist/changelog/v1-0-0/index.html +446 -0
  25. package/site/dist/changelog/v1-0-1/index.html +437 -0
  26. package/site/dist/changelog/v1-1-0/index.html +445 -0
  27. package/site/dist/changelog/v1-2-0/index.html +443 -0
  28. package/site/dist/changelog/v1-3-0/index.html +448 -0
  29. package/site/dist/changelog/v1-4-0/index.html +445 -0
  30. package/site/dist/changelog/v1-5-0/index.html +439 -0
  31. package/site/dist/changelog/v1-5-1/index.html +443 -0
  32. package/site/dist/changelog/v1-6-0/index.html +467 -0
  33. package/site/dist/changelog/v1-7-0/index.html +462 -0
  34. package/site/dist/changelog/v1-8-0/index.html +481 -0
  35. package/site/dist/changelog/v1-8-1/index.html +457 -0
  36. package/site/dist/changelog/v1-9-0/index.html +495 -0
  37. package/site/dist/changelog/v2-0-0/index.html +500 -0
  38. package/site/dist/changelog/v2-1-0/index.html +476 -0
  39. package/site/dist/changelog-latest.json +269 -0
  40. package/site/dist/changelog.json +399 -0
  41. package/site/dist/css/api.css +1113 -0
  42. package/site/dist/css/highlight/highlight.min.js +1433 -0
  43. package/site/dist/css/highlight/styles/base16/docula.css +123 -0
  44. package/site/dist/css/home.css +133 -0
  45. package/site/dist/css/styles.css +1227 -0
  46. package/site/dist/css/variables.css +32 -0
  47. package/site/dist/docs/bins/index.html +980 -0
  48. package/site/dist/docs/configuration/index.html +809 -0
  49. package/site/dist/docs/hosted/index.html +583 -0
  50. package/site/dist/docs/how-to-deploy/cloudflare/index.html +655 -0
  51. package/site/dist/docs/how-to-deploy/docker/index.html +664 -0
  52. package/site/dist/docs/how-to-deploy/wasmer/index.html +625 -0
  53. package/site/dist/docs/https/index.html +796 -0
  54. package/site/dist/docs/index.html +640 -0
  55. package/site/dist/docs/library/index.html +818 -0
  56. package/site/dist/docs/taps/index.html +746 -0
  57. package/site/dist/favicon.svg +14 -0
  58. package/site/dist/feed.xml +1 -0
  59. package/site/dist/index.html +640 -0
  60. package/site/dist/js/api.js +363 -0
  61. package/site/dist/js/search.js +436 -0
  62. package/site/dist/llms-full.txt +7640 -0
  63. package/site/dist/llms.txt +43 -0
  64. package/site/dist/logo.svg +21 -0
  65. package/site/dist/robots.txt +2 -0
  66. package/site/dist/search-index.json +1 -0
  67. package/site/dist/sitemap.xml +1 -0
@@ -0,0 +1,640 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="UTF-8">
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
+ <meta name="description" content="HTTP mock server and httpbin replacement for API testing. Run it at mockhttp.org, in Docker, or in Node.js.">
8
+ <link rel="stylesheet" href="/css/variables.css">
9
+ <link rel="stylesheet" href="/css/styles.css">
10
+ <link rel="stylesheet" href="/css/highlight/styles/base16/docula.css">
11
+ <link rel="icon" href="/logo.svg">
12
+ <script>
13
+ (function(){
14
+ window.__doculaThemeKey = 'docula:theme:' + ('https://mockhttp.org').replace(/^https?:\/\//, '');
15
+ var mode = localStorage.getItem(window.__doculaThemeKey) || 'light';
16
+ var resolved = mode === 'system'
17
+ ? (window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark')
18
+ : mode;
19
+ if (resolved === 'light') document.documentElement.setAttribute('data-theme', 'light');
20
+ try {
21
+ var authState = JSON.parse(localStorage.getItem('docula-auth-state'));
22
+ if (authState) {
23
+ window.__doculaAuth = authState;
24
+ if (authState.loggedIn) {
25
+ document.documentElement.classList.add('docula-auth-logged-in');
26
+ }
27
+ }
28
+ } catch (e) {
29
+ // Ignore localStorage parsing errors
30
+ }
31
+ if (!window.__doculaAuth) {
32
+ window.__doculaAuth = { loggedIn: false, displayName: null };
33
+ }
34
+ })();
35
+ </script>
36
+ <title>MockHTTP - Getting Started</title>
37
+ <script type="application/ld+json">
38
+ {"@context":"https://schema.org","@type":"TechArticle","headline":"Getting Started","description":"","url":"https://mockhttp.org/","publisher":{"@type":"Organization","name":"MockHTTP"},"dateModified":"2026-10-03","keywords":[]}
39
+ </script>
40
+ </head>
41
+
42
+ <body>
43
+ <header class="header">
44
+ <div class="header-top">
45
+ <div class="header-top__content">
46
+ <button class="mobile-menu-toggle" id="mobile-menu-toggle" aria-label="Toggle navigation menu">
47
+ <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="4" x2="20" y1="12" y2="12"/><line x1="4" x2="20" y1="6" y2="6"/><line x1="4" x2="20" y1="18" y2="18"/></svg>
48
+ </button>
49
+ <a href="/" class="logo-link">
50
+ <img alt="MockHTTP" class="logo__img" src="/logo.svg">
51
+ </a>
52
+ <nav class="header-bottom__nav">
53
+ <a class="header-bottom__item" href="/docs/" id="nav-docs">
54
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 7v14"/><path d="M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
55
+ <span>Documentation</span>
56
+ </a>
57
+ <a class="header-bottom__item" href="/api" id="nav-api">
58
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m16 18 6-6-6-6"/><path d="m8 6-6 6 6 6"/></svg>
59
+ <span>API Reference</span>
60
+ </a>
61
+ <a class="header-bottom__item" href="/changelog/" id="nav-changelog">
62
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M11 6a13 13 0 0 0 8.4-2.8A1 1 0 0 1 21 4v12a1 1 0 0 1-1.6.8A13 13 0 0 0 11 14H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2z"/><path d="M6 14a12 12 0 0 0 2.4 7.2 2 2 0 0 0 3.2-2.4A8 8 0 0 1 10 14"/><path d="M8 6v8"/></svg>
63
+ <span>Changelog</span>
64
+ </a>
65
+ </nav>
66
+ <div class="header-actions">
67
+ <button class="search-button" id="search-button" type="button" aria-label="Search" aria-keyshortcuts="Meta+K Control+K">
68
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><path d="m21 21-4.3-4.3"/></svg>
69
+ <span class="search-button__text">Search</span>
70
+ <span class="search-button__shortcut">⌘K</span>
71
+ </button>
72
+ <button class="theme-button" id="theme-toggle" aria-label="Theme: system (following system)">
73
+ <svg class="theme-button__icon theme-button__icon--system" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="2" y="3" width="20" height="14" rx="2"/><line x1="8" x2="16" y1="21" y2="21"/><line x1="12" x2="12" y1="17" y2="21"/></svg>
74
+ <svg class="theme-button__icon theme-button__icon--sun theme-button__icon--hidden" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="4"/><path d="M12 2v2"/><path d="M12 20v2"/><path d="m4.93 4.93 1.41 1.41"/><path d="m17.66 17.66 1.41 1.41"/><path d="M2 12h2"/><path d="M20 12h2"/><path d="m6.34 17.66-1.41 1.41"/><path d="m19.07 4.93-1.41 1.41"/></svg>
75
+ <svg class="theme-button__icon theme-button__icon--moon theme-button__icon--hidden" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401"/></svg>
76
+ </button>
77
+ </div>
78
+ </div>
79
+ </div>
80
+ </header>
81
+ <aside class="mobile-sidebar" id="mobile-sidebar">
82
+ <nav class="mobile-nav">
83
+ <a class="mobile-nav__item" href="/docs/">
84
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 7v14"/><path d="M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
85
+ <span>Documentation</span>
86
+ </a>
87
+ <a class="mobile-nav__item" href="/api">
88
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m16 18 6-6-6-6"/><path d="m8 6-6 6 6 6"/></svg>
89
+ <span>API Reference</span>
90
+ </a>
91
+ <a class="mobile-nav__item" href="/changelog/">
92
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M11 6a13 13 0 0 0 8.4-2.8A1 1 0 0 1 21 4v12a1 1 0 0 1-1.6.8A13 13 0 0 0 11 14H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2z"/><path d="M6 14a12 12 0 0 0 2.4 7.2 2 2 0 0 0 3.2-2.4A8 8 0 0 1 10 14"/><path d="M8 6v8"/></svg>
93
+ <span>Changelog</span>
94
+ </a>
95
+ </nav>
96
+ <div class="mobile-sidebar__docs" id="mobile-sidebar-docs"></div>
97
+ </aside>
98
+ <div class="sidebar-backdrop" id="sidebar-backdrop"></div>
99
+ <div class="search-modal" id="search-modal" hidden>
100
+ <div class="search-modal__backdrop" data-search-close></div>
101
+ <div class="search-modal__panel" role="dialog" aria-modal="true" aria-label="Search">
102
+ <div class="search-modal__header">
103
+ <svg class="search-modal__icon" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><path d="m21 21-4.3-4.3"/></svg>
104
+ <input
105
+ type="search"
106
+ id="search-input"
107
+ class="search-modal__input"
108
+ placeholder="Search"
109
+ autocomplete="off"
110
+ autocorrect="off"
111
+ autocapitalize="off"
112
+ spellcheck="false"
113
+ aria-label="Search"
114
+ aria-controls="search-results"
115
+ aria-activedescendant=""
116
+ role="combobox"
117
+ aria-expanded="true"
118
+ />
119
+ <button class="search-modal__clear" id="search-clear" type="button" aria-label="Clear search" hidden>
120
+ <svg xmlns="http://www.w3.org/2000/svg" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="18" y1="6" x2="6" y2="18"/><line x1="6" y1="6" x2="18" y2="18"/></svg>
121
+ </button>
122
+ </div>
123
+ <div class="search-modal__body">
124
+ <ul class="search-results" id="search-results" role="listbox" aria-label="Search results"></ul>
125
+ <div class="search-modal__empty" id="search-empty" hidden>
126
+ No results for "<span class="search-modal__empty-query" id="search-empty-query"></span>"
127
+ </div>
128
+ <div class="search-modal__initial" id="search-initial">
129
+ Type to search the documentation.
130
+ </div>
131
+ </div>
132
+ <div class="search-modal__footer">
133
+ <span class="search-modal__hint"><kbd class="search-modal__kbd">↑</kbd><kbd class="search-modal__kbd">↓</kbd> to navigate</span>
134
+ <span class="search-modal__hint"><kbd class="search-modal__kbd">↵</kbd> to select</span>
135
+ <span class="search-modal__hint"><kbd class="search-modal__kbd">esc</kbd> to close</span>
136
+ </div>
137
+ </div>
138
+ </div>
139
+ <script>
140
+ window.__doculaSearch = { indexUrl: "/search-index.json" };
141
+ </script>
142
+ <script src="/js/search.js" defer></script>
143
+ <div class="page-dropdown" id="page-dropdown">
144
+ <button class="page-dropdown__toggle" id="page-dropdown-toggle">
145
+ <span class="page-dropdown__title">Getting Started</span>
146
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m7 15 5 5 5-5"/><path d="m7 9 5-5 5 5"/></svg>
147
+ </button>
148
+ <div class="page-dropdown__list" id="page-dropdown-list">
149
+ <section class="nav-sidebar__section">
150
+ <ul class="nav-sidebar__list">
151
+ <li>
152
+ <a href="/docs/" class="nav-sidebar__item">Getting Started</a>
153
+ </li>
154
+ </ul>
155
+ </section>
156
+ <section class="nav-sidebar__section">
157
+ <ul class="nav-sidebar__list">
158
+ <li>
159
+ <a href="/docs/https/" class="nav-sidebar__item">HTTPS and HTTP/2</a>
160
+ </li>
161
+ </ul>
162
+ </section>
163
+ <section class="nav-sidebar__section">
164
+ <ul class="nav-sidebar__list">
165
+ <li>
166
+ <a href="/docs/taps/" class="nav-sidebar__item">Taps</a>
167
+ </li>
168
+ </ul>
169
+ </section>
170
+ <section class="nav-sidebar__section">
171
+ <ul class="nav-sidebar__list">
172
+ <li>
173
+ <a href="/docs/bins/" class="nav-sidebar__item">Bins</a>
174
+ </li>
175
+ </ul>
176
+ </section>
177
+ <section class="nav-sidebar__section">
178
+ <ul class="nav-sidebar__list">
179
+ <li>
180
+ <a href="/docs/configuration/" class="nav-sidebar__item">Configuration</a>
181
+ </li>
182
+ </ul>
183
+ </section>
184
+ <section class="nav-sidebar__section">
185
+ <ul class="nav-sidebar__list">
186
+ <li>
187
+ <a href="/docs/library/" class="nav-sidebar__item">Library API</a>
188
+ </li>
189
+ </ul>
190
+ </section>
191
+ <section class="nav-sidebar__section">
192
+ <ul class="nav-sidebar__list">
193
+ <li>
194
+ <a href="/docs/hosted/" class="nav-sidebar__item">MockHttp.org Live</a>
195
+ </li>
196
+ </ul>
197
+ </section>
198
+ <section class="nav-sidebar__section nav-sidebar__section--collapsible">
199
+ <h2 class="nav-sidebar__title">
200
+ <button type="button" class="nav-sidebar__toggle" aria-expanded="true">
201
+ <span class="nav-sidebar__toggle-label">How to Deploy</span>
202
+ <svg class="nav-sidebar__chevron" xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><polyline points="6 9 12 15 18 9"/></svg>
203
+ </button>
204
+ </h2>
205
+ <ul class="nav-sidebar__list">
206
+ <li>
207
+ <a href="/docs/how-to-deploy/cloudflare/" class="nav-sidebar__item">Cloudflare</a>
208
+ </li>
209
+ <li>
210
+ <a href="/docs/how-to-deploy/docker/" class="nav-sidebar__item">Docker</a>
211
+ </li>
212
+ <li>
213
+ <a href="/docs/how-to-deploy/wasmer/" class="nav-sidebar__item">Wasmer</a>
214
+ </li>
215
+ </ul>
216
+ </section>
217
+ </div>
218
+ </div>
219
+ <div class="content">
220
+ <aside class="nav-sidebar" id="nav-sidebar">
221
+ <section class="nav-sidebar__section">
222
+ <ul class="nav-sidebar__list">
223
+ <li>
224
+ <a href="/docs/" class="nav-sidebar__item">Getting Started</a>
225
+ </li>
226
+ </ul>
227
+ </section>
228
+ <section class="nav-sidebar__section">
229
+ <ul class="nav-sidebar__list">
230
+ <li>
231
+ <a href="/docs/https/" class="nav-sidebar__item">HTTPS and HTTP/2</a>
232
+ </li>
233
+ </ul>
234
+ </section>
235
+ <section class="nav-sidebar__section">
236
+ <ul class="nav-sidebar__list">
237
+ <li>
238
+ <a href="/docs/taps/" class="nav-sidebar__item">Taps</a>
239
+ </li>
240
+ </ul>
241
+ </section>
242
+ <section class="nav-sidebar__section">
243
+ <ul class="nav-sidebar__list">
244
+ <li>
245
+ <a href="/docs/bins/" class="nav-sidebar__item">Bins</a>
246
+ </li>
247
+ </ul>
248
+ </section>
249
+ <section class="nav-sidebar__section">
250
+ <ul class="nav-sidebar__list">
251
+ <li>
252
+ <a href="/docs/configuration/" class="nav-sidebar__item">Configuration</a>
253
+ </li>
254
+ </ul>
255
+ </section>
256
+ <section class="nav-sidebar__section">
257
+ <ul class="nav-sidebar__list">
258
+ <li>
259
+ <a href="/docs/library/" class="nav-sidebar__item">Library API</a>
260
+ </li>
261
+ </ul>
262
+ </section>
263
+ <section class="nav-sidebar__section">
264
+ <ul class="nav-sidebar__list">
265
+ <li>
266
+ <a href="/docs/hosted/" class="nav-sidebar__item">MockHttp.org Live</a>
267
+ </li>
268
+ </ul>
269
+ </section>
270
+ <section class="nav-sidebar__section nav-sidebar__section--collapsible">
271
+ <h2 class="nav-sidebar__title">
272
+ <button type="button" class="nav-sidebar__toggle" aria-expanded="true">
273
+ <span class="nav-sidebar__toggle-label">How to Deploy</span>
274
+ <svg class="nav-sidebar__chevron" xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><polyline points="6 9 12 15 18 9"/></svg>
275
+ </button>
276
+ </h2>
277
+ <ul class="nav-sidebar__list">
278
+ <li>
279
+ <a href="/docs/how-to-deploy/cloudflare/" class="nav-sidebar__item">Cloudflare</a>
280
+ </li>
281
+ <li>
282
+ <a href="/docs/how-to-deploy/docker/" class="nav-sidebar__item">Docker</a>
283
+ </li>
284
+ <li>
285
+ <a href="/docs/how-to-deploy/wasmer/" class="nav-sidebar__item">Wasmer</a>
286
+ </li>
287
+ </ul>
288
+ </section>
289
+ </aside>
290
+ <article class="article">
291
+ <header class="article__header">
292
+ <h1 class="article__title">Getting Started</h1>
293
+ </header>
294
+ <div class="article__body">
295
+ <main class="article__main">
296
+ <p><a href="https://github.com/jaredwray/mockhttp/actions/workflows/tests.yaml"><img src="https://github.com/jaredwray/mockhttp/actions/workflows/tests.yaml/badge.svg" alt="tests"></a>
297
+ <a href="https://github.com/jaredwray/mockhttp/blob/master/LICENSE"><img src="https://img.shields.io/github/license/jaredwray/mockhttp" alt="GitHub license"></a>
298
+ <a href="https://codecov.io/gh/jaredwray/mockhttp"><img src="https://codecov.io/gh/jaredwray/mockhttp/graph/badge.svg?token=eqtqoA3olU" alt="codecov"></a>
299
+ <a href="https://npmjs.com/package/@jaredwray/mockhttp"><img src="https://img.shields.io/npm/dm/@jaredwray/mockhttp" alt="npm"></a>
300
+ <a href="https://npmjs.com/package/@jaredwray/mockhttp"><img src="https://img.shields.io/npm/v/@jaredwray/mockhttp" alt="npm"></a>
301
+ <a href="https://hub.docker.com/r/jaredwray/mockhttp"><img src="https://img.shields.io/docker/pulls/jaredwray/mockhttp" alt="Docker Pulls"></a>
302
+ <a href="https://mockhttp.org"><img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fjaredwray.com%2Fapi%2Fmockhttp-traffic&#x26;query=%24.message&#x26;label=mockhttp.org" alt="mockhttp.org"></a></p>
303
+ <p>A simple HTTP server for mocking responses in tests. Inspired by <a href="https://httpbin.org/">httpbin</a> and built with Node.js and Fastify. Run it at <a href="https://mockhttp.org">mockhttp.org</a>, with Docker (<code>jaredwray/mockhttp</code>), or in Node.js (<code>npm install @jaredwray/mockhttp</code>).</p>
304
+ <h2 id="table-of-contents">Table of Contents</h2>
305
+ <ul>
306
+ <li><a href="#features">Features</a></li>
307
+ <li><a href="#deploy-via-docker">Deploy via Docker</a></li>
308
+ <li><a href="#deploy-via-docker-compose">Deploy via Docker Compose</a></li>
309
+ <li><a href="#deploy-via-nodejs">Deploy via Node.js</a></li>
310
+ </ul>
311
+ <h2 id="features">Features</h2>
312
+ <ul>
313
+ <li>All the features of <a href="https://httpbin.org/">httpbin</a></li>
314
+ <li><a href="/docs/taps/">Taps</a> — inject custom responses for testing and development</li>
315
+ <li><a href="/docs/bins/">Bins</a> — capture and inspect incoming HTTP requests (great for webhook debugging)</li>
316
+ <li><code>@fastify/helmet</code> built in by default</li>
317
+ <li>Built with Node.js, TypeScript, and Fastify</li>
318
+ <li>Run it in Node.js, or deploy with <a href="/docs/how-to-deploy/docker/">Docker</a>, <a href="/docs/how-to-deploy/cloudflare/">Cloudflare Workers</a>, or <a href="/docs/how-to-deploy/wasmer/">Wasmer Edge</a></li>
319
+ <li>Free hosted service at <a href="https://mockhttp.org">mockhttp.org</a>, running on Cloudflare</li>
320
+ <li>Documentation site and interactive <a href="/api/">OpenAPI reference</a></li>
321
+ <li>Auto-detect the next port that is not in use</li>
322
+ <li><a href="/docs/https/">HTTPS and HTTP/2</a>, plus <a href="/docs/configuration/">rate limiting, logging, and URL matching</a></li>
323
+ </ul>
324
+ <h2 id="deploy-via-docker">Deploy via Docker</h2>
325
+ <pre><code class="hljs language-bash">docker run -d -p 3000:3000 jaredwray/mockhttp
326
+ </code></pre>
327
+ <h2 id="deploy-via-docker-compose">Deploy via Docker Compose</h2>
328
+ <pre><code class="hljs language-yaml"><span class="hljs-attr">services:</span>
329
+ <span class="hljs-attr">mockhttp:</span>
330
+ <span class="hljs-attr">image:</span> <span class="hljs-string">jaredwray/mockhttp:latest</span>
331
+ <span class="hljs-attr">ports:</span>
332
+ <span class="hljs-bullet">-</span> <span class="hljs-string">"3000:3000"</span>
333
+ </code></pre>
334
+ <p>If you want to run it on a different port, just change the <code>3000</code> to whatever port you want and add in the environment variable <code>PORT</code> to the environment.</p>
335
+ <pre><code class="hljs language-yaml"><span class="hljs-attr">services:</span>
336
+ <span class="hljs-attr">mockhttp:</span>
337
+ <span class="hljs-attr">image:</span> <span class="hljs-string">jaredwray/mockhttp:latest</span>
338
+ <span class="hljs-attr">ports:</span>
339
+ <span class="hljs-bullet">-</span> <span class="hljs-string">"3001:3001"</span>
340
+ <span class="hljs-attr">environment:</span>
341
+ <span class="hljs-bullet">-</span> <span class="hljs-string">PORT=3001</span>
342
+ </code></pre>
343
+ <p>You can see an example of this in the <a href="https://github.com/jaredwray/mockhttp/blob/main/docker-compose.yaml">docker-compose.yaml</a> file.</p>
344
+ <h2 id="deploy-via-nodejs">Deploy via Node.js</h2>
345
+ <pre><code class="hljs language-bash">npm install @jaredwray/mockhttp --save
346
+ </code></pre>
347
+ <p>then run <code>mockhttp</code> in your code.</p>
348
+ <pre><code class="hljs language-javascript"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">MockHttp</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'@jaredwray/mockhttp'</span>;
349
+ <span class="hljs-keyword">const</span> mock = <span class="hljs-keyword">new</span> <span class="hljs-title class_">MockHttp</span>();
350
+ <span class="hljs-keyword">await</span> mock.<span class="hljs-title function_">start</span>(); <span class="hljs-comment">// start the server</span>
351
+ <span class="hljs-keyword">const</span> response = <span class="hljs-keyword">await</span> <span class="hljs-title function_">fetch</span>(<span class="hljs-string">'http://localhost:3000/get'</span>);
352
+ <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(response);
353
+ <span class="hljs-keyword">await</span> mock.<span class="hljs-title function_">close</span>(); <span class="hljs-comment">// stop the server</span>
354
+ </code></pre>
355
+ <p>Step-by-step deploy guides: <a href="/docs/how-to-deploy/docker/">Docker</a>, <a href="/docs/how-to-deploy/cloudflare/">Cloudflare</a>, and <a href="/docs/how-to-deploy/wasmer/">Wasmer</a>.</p>
356
+ </main>
357
+ <aside class="content-aside">
358
+ <h2 class="content-aside__title">TABLE OF CONTENTS</h2>
359
+ <ul class="content-aside__list" id="toc-list">
360
+ </ul>
361
+ </aside>
362
+ </div>
363
+ <a class="article__edit-link" href="https://github.com/jaredwray/mockhttp/edit/main/site/docs/index.md" target="_blank" rel="noopener noreferrer">
364
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M17 3a2.85 2.83 0 1 1 4 4L7.5 20.5 2 22l1.5-5.5Z"/><path d="m15 5 4 4"/></svg>
365
+ Edit this page
366
+ </a>
367
+ </article>
368
+ </div>
369
+ <footer>
370
+ <a href="/llms.txt" class="footer__link">llms.txt</a>
371
+ <a href="/feed.xml" class="footer__link" aria-label="RSS Feed">
372
+ <svg class="footer__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><circle cx="6.18" cy="17.82" r="2.18"/><path d="M4 4.44v2.83c7.03 0 12.73 5.7 12.73 12.73h2.83c0-8.59-6.97-15.56-15.56-15.56zm0 5.66v2.83c3.9 0 7.07 3.17 7.07 7.07h2.83c0-5.47-4.43-9.9-9.9-9.9z"/></svg>
373
+ </a>
374
+
375
+ <a href="https://docula.org/" target="_blank" rel="noopener noreferrer" class="footer__link" aria-label="Docula">
376
+ <svg class="footer__bat" xmlns="http://www.w3.org/2000/svg" viewBox="70 110 360 205" fill="currentColor"><path d="M420,173c-16.76-18-72.78-36.65-131.59-30.58A160.15,160.15,0,0,0,269,120.55c-3.78,4.52-11.15,9.45-19,9.45s-15.23-4.93-19-9.45a160.15,160.15,0,0,0-19.4,21.83C152.78,136.31,96.76,154.94,80,173c48.86,5.86,79.5,34.09,79.5,72.06,52.37,0,77,28,90.5,59.94C263.54,273,288.13,245,340.5,245,340.5,207,371.14,178.8,420,173Z"/><circle cx="239.19" cy="145.36" r="3.32" fill="#fff"/><circle cx="260.81" cy="145.36" r="3.32" fill="#fff"/></svg>
377
+ </a>
378
+ <span class="footer__updated">updated: 2026-10-03</span>
379
+ </footer>
380
+ <script src="/css/highlight/highlight.min.js"></script>
381
+ <script>
382
+ document.addEventListener('DOMContentLoaded', () => {
383
+ document.querySelectorAll('pre code').forEach(el => { el.textContent = el.textContent.trimEnd(); });
384
+ hljs.highlightAll();
385
+ var kbd = document.querySelector('.search-button__shortcut');
386
+ if (kbd) kbd.textContent = navigator.platform.indexOf('Mac') > -1 ? '⌘K' : 'Ctrl K';
387
+
388
+ // Copy code buttons
389
+ const copyIcon = '<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="9" y="9" width="13" height="13" rx="2" ry="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg>';
390
+ const checkIcon = '<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="20 6 9 17 4 12"/></svg>';
391
+ document.querySelectorAll('pre').forEach(function(pre) {
392
+ const btn = document.createElement('button');
393
+ btn.className = 'copy-code-btn';
394
+ btn.innerHTML = copyIcon;
395
+ btn.setAttribute('aria-label', 'Copy code');
396
+ btn.addEventListener('click', function() {
397
+ const code = pre.querySelector('code');
398
+ const text = code ? code.textContent : pre.textContent;
399
+ navigator.clipboard.writeText(text || '').then(function() {
400
+ btn.innerHTML = checkIcon;
401
+ setTimeout(function() { btn.innerHTML = copyIcon; }, 2000);
402
+ });
403
+ });
404
+ pre.appendChild(btn);
405
+ });
406
+ });
407
+ </script>
408
+ <script>
409
+ (function() {
410
+ var themeKey = window.__doculaThemeKey;
411
+ function getMode() {
412
+ return localStorage.getItem(themeKey) || 'light';
413
+ }
414
+
415
+ function resolveTheme(mode) {
416
+ if (mode === 'system') {
417
+ return window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark';
418
+ }
419
+ return mode;
420
+ }
421
+
422
+ var cachedEls = null;
423
+ function getThemeEls() {
424
+ if (!cachedEls) {
425
+ cachedEls = {
426
+ systemIcon: document.querySelector('.theme-button__icon--system'),
427
+ sunIcon: document.querySelector('.theme-button__icon--sun'),
428
+ moonIcon: document.querySelector('.theme-button__icon--moon'),
429
+ toggle: document.getElementById('theme-toggle')
430
+ };
431
+ }
432
+ return cachedEls;
433
+ }
434
+
435
+ function applyTheme(mode) {
436
+ var resolved = resolveTheme(mode);
437
+ if (resolved === 'light') {
438
+ document.documentElement.setAttribute('data-theme', 'light');
439
+ } else {
440
+ document.documentElement.removeAttribute('data-theme');
441
+ }
442
+
443
+ var els = getThemeEls();
444
+ if (els.systemIcon && els.sunIcon && els.moonIcon) {
445
+ els.systemIcon.classList.add('theme-button__icon--hidden');
446
+ els.sunIcon.classList.add('theme-button__icon--hidden');
447
+ els.moonIcon.classList.add('theme-button__icon--hidden');
448
+ if (mode === 'system') {
449
+ els.systemIcon.classList.remove('theme-button__icon--hidden');
450
+ } else if (mode === 'light') {
451
+ els.sunIcon.classList.remove('theme-button__icon--hidden');
452
+ } else {
453
+ els.moonIcon.classList.remove('theme-button__icon--hidden');
454
+ }
455
+ }
456
+
457
+ if (els.toggle) {
458
+ var labels = { system: 'Theme: system (following system)', light: 'Theme: light', dark: 'Theme: dark' };
459
+ els.toggle.setAttribute('aria-label', labels[mode] || 'Toggle theme');
460
+ }
461
+ }
462
+
463
+ function nextMode(current) {
464
+ var cycle = { system: 'light', light: 'dark', dark: 'system' };
465
+ return cycle[current] || 'system';
466
+ }
467
+
468
+ var currentMode = getMode();
469
+
470
+ document.addEventListener('DOMContentLoaded', function() {
471
+ applyTheme(currentMode);
472
+
473
+ var els = getThemeEls();
474
+ if (els.toggle) {
475
+ els.toggle.addEventListener('click', function() {
476
+ currentMode = nextMode(currentMode);
477
+ localStorage.setItem(themeKey, currentMode);
478
+ applyTheme(currentMode);
479
+ });
480
+ }
481
+ });
482
+
483
+ window.matchMedia('(prefers-color-scheme: light)').addEventListener('change', function() {
484
+ if (getMode() === 'system') {
485
+ applyTheme('system');
486
+ }
487
+ });
488
+ })();
489
+ </script>
490
+ <script defer>
491
+ document.addEventListener('DOMContentLoaded', () => {
492
+ const menuToggle = document.getElementById('mobile-menu-toggle');
493
+ const mobileSidebar = document.getElementById('mobile-sidebar');
494
+ const backdrop = document.getElementById('sidebar-backdrop');
495
+ if (menuToggle && mobileSidebar) {
496
+ menuToggle.addEventListener('click', () => {
497
+ mobileSidebar.classList.toggle('mobile-sidebar--open');
498
+ if (backdrop) backdrop.classList.toggle('sidebar-backdrop--visible');
499
+ });
500
+ if (backdrop) {
501
+ backdrop.addEventListener('click', () => {
502
+ mobileSidebar.classList.remove('mobile-sidebar--open');
503
+ backdrop.classList.remove('sidebar-backdrop--visible');
504
+ });
505
+ }
506
+ }
507
+
508
+ // Page dropdown toggle (docs pages)
509
+ const dropdownToggle = document.getElementById('page-dropdown-toggle');
510
+ const dropdownList = document.getElementById('page-dropdown-list');
511
+ if (dropdownToggle && dropdownList) {
512
+ dropdownToggle.addEventListener('click', () => {
513
+ dropdownList.classList.toggle('page-dropdown__list--open');
514
+ });
515
+ }
516
+
517
+ // Active sidebar link highlighting
518
+ const sidebarLinks = document.querySelectorAll('.nav-sidebar__item');
519
+ const currentPath = window.location.pathname;
520
+ sidebarLinks.forEach((link) => {
521
+ if (link.getAttribute('href') === currentPath || link.getAttribute('href') === currentPath.replace(/\/$/, '')) {
522
+ link.classList.add('nav-sidebar__item--active');
523
+ }
524
+ });
525
+
526
+ // Sidebar section collapse/expand
527
+ const SIDEBAR_STORAGE_KEY = 'docula:sidebar-sections';
528
+ const collapsibleSections = document.querySelectorAll('.nav-sidebar__section--collapsible');
529
+ if (collapsibleSections.length > 0) {
530
+ let storedSectionState = {};
531
+ try {
532
+ storedSectionState = JSON.parse(localStorage.getItem(SIDEBAR_STORAGE_KEY) || '{}');
533
+ } catch (e) { storedSectionState = {}; }
534
+
535
+ const setSectionOpen = (section, toggle, open) => {
536
+ toggle.setAttribute('aria-expanded', open ? 'true' : 'false');
537
+ section.classList.toggle('nav-sidebar__section--collapsed', !open);
538
+ };
539
+
540
+ collapsibleSections.forEach((section, idx) => {
541
+ const toggle = section.querySelector('.nav-sidebar__toggle');
542
+ const list = section.querySelector('.nav-sidebar__list');
543
+ if (!toggle || !list) return;
544
+ const listId = 'nav-sidebar-section-' + idx;
545
+ list.id = listId;
546
+ toggle.setAttribute('aria-controls', listId);
547
+
548
+ const key = 'section-' + idx;
549
+ const hasStored = Object.prototype.hasOwnProperty.call(storedSectionState, key);
550
+ const isOpen = hasStored ? !!storedSectionState[key] : true;
551
+ setSectionOpen(section, toggle, isOpen);
552
+
553
+ toggle.addEventListener('click', () => {
554
+ const next = toggle.getAttribute('aria-expanded') !== 'true';
555
+ setSectionOpen(section, toggle, next);
556
+ storedSectionState[key] = next;
557
+ try {
558
+ localStorage.setItem(SIDEBAR_STORAGE_KEY, JSON.stringify(storedSectionState));
559
+ } catch (e) { /* storage unavailable */ }
560
+ });
561
+ });
562
+ }
563
+
564
+ // Active nav link highlighting (header + mobile). Highlight only the
565
+ // single most-specific link: the one whose path is the longest prefix of
566
+ // the current path. A plain startsWith() check lights up every link whose
567
+ // path merely prefixes the current one, so when the site is embedded under
568
+ // a base path (e.g. served at /developer with docs at that root) the
569
+ // Documentation link — whose path is a prefix of every page — would stay
570
+ // highlighted everywhere. Trailing slashes are normalized so matches stop
571
+ // at a path boundary. We read the anchor's resolved origin/pathname so
572
+ // absolute, relative, and same-origin hrefs all work, while cross-origin
573
+ // links and non-anchor items (e.g. the mobile logout button) are skipped.
574
+ const withTrailingSlash = (p) => (p.endsWith('/') ? p : p + '/');
575
+ const here = withTrailingSlash(currentPath);
576
+ const markActiveNav = (selector, activeClass) => {
577
+ let bestLink = null;
578
+ let bestLength = -1;
579
+ document.querySelectorAll(selector).forEach((link) => {
580
+ // Only same-origin anchors can match the current pathname.
581
+ if (!link.href || link.origin !== window.location.origin) return;
582
+ const base = withTrailingSlash(link.pathname);
583
+ if (here.startsWith(base) && base.length > bestLength) {
584
+ bestLink = link;
585
+ bestLength = base.length;
586
+ }
587
+ });
588
+ if (bestLink) bestLink.classList.add(activeClass);
589
+ };
590
+ markActiveNav('.header-bottom__item', 'header-bottom__item--active');
591
+ markActiveNav('.mobile-nav__item', 'mobile-nav__item--active');
592
+
593
+ // TOC extraction: move the inline TOC into the right sidebar and hide the original
594
+ const tocHeading = document.getElementById('table-of-contents');
595
+ if (tocHeading) {
596
+ const tocList = tocHeading.nextElementSibling;
597
+ const tocTarget = document.getElementById('toc-list');
598
+ if (tocList && tocList.tagName === 'UL' && tocTarget) {
599
+ tocTarget.innerHTML = tocList.innerHTML;
600
+ tocHeading.style.display = 'none';
601
+ tocList.style.display = 'none';
602
+ }
603
+ }
604
+
605
+ // Hide the TOC aside if it has no entries
606
+ const tocSidebar = document.getElementById('toc-list');
607
+ if (tocSidebar && tocSidebar.children.length === 0) {
608
+ const aside = tocSidebar.closest('.content-aside');
609
+ if (aside) { aside.style.display = 'none'; }
610
+ }
611
+
612
+ // Image lightbox
613
+ const lightboxOverlay = document.createElement('div');
614
+ lightboxOverlay.className = 'lightbox-overlay';
615
+ lightboxOverlay.addEventListener('click', function(e) {
616
+ if (e.target !== lightboxImg) lightboxOverlay.classList.remove('lightbox-overlay--visible');
617
+ });
618
+ const lightboxClose = document.createElement('button');
619
+ lightboxClose.className = 'lightbox-close';
620
+ lightboxClose.innerHTML = '<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="18" y1="6" x2="6" y2="18"/><line x1="6" y1="6" x2="18" y2="18"/></svg>';
621
+ lightboxClose.addEventListener('click', function() {
622
+ lightboxOverlay.classList.remove('lightbox-overlay--visible');
623
+ });
624
+ const lightboxImg = document.createElement('img');
625
+ lightboxOverlay.appendChild(lightboxClose);
626
+ lightboxOverlay.appendChild(lightboxImg);
627
+ document.body.appendChild(lightboxOverlay);
628
+
629
+ document.querySelectorAll('.article__main img, .changelog-entry-body img').forEach(function(img) {
630
+ if (img.closest('a')) return;
631
+ img.addEventListener('click', function() {
632
+ lightboxImg.src = img.src;
633
+ lightboxOverlay.classList.add('lightbox-overlay--visible');
634
+ });
635
+ });
636
+ });
637
+ </script>
638
+ </body>
639
+
640
+ </html>