|
1 | | -# HTTP Status Code Reference Pro |
2 | | - |
3 | | -A searchable, backend-dev-focused reference for every HTTP status code — with a built-in helper that maps common API scenarios to the status code that actually fits. |
4 | | - |
5 | | -> Stop guessing between 401 and 403, or 409 and 422. Look up any of the 62 IANA-registered HTTP status codes by number or keyword, or describe the situation your API is in and get the right code with a one-line justification for why it's correct — all offline, in your browser. |
6 | | -
|
7 | | -## Overview |
8 | | - |
9 | | -HTTP Status Code Reference Pro is part of the **Web Utility Suite**. It runs entirely in the browser with no build step, no frameworks, and no network calls — open `index.html` from disk and it works. The tool ships a complete, accurate dataset of every status code registered in the IANA HTTP Status Code Registry (1xx through 5xx, including the WebDAV extension codes), grouped by category and instantly searchable. A dedicated "Which code should I use?" panel covers the everyday API-design decisions backend developers actually face — creation, validation, auth, rate limiting, redirects, and failure modes — each with a short explanation of *why* that code is the right one, not just a lookup table. |
10 | | - |
11 | | -## Features |
12 | | - |
13 | | -- **Complete, accurate dataset** — all 62 IANA-registered status codes (100–511), each with its correct RFC name and a precise one-to-two-sentence description. |
14 | | -- **Category tabs** — filter to 1xx Informational, 2xx Success, 3xx Redirection, 4xx Client Error, or 5xx Server Error, or view everything at once. |
15 | | -- **Live free-text search** — matches against the code number, its name, or its description simultaneously, with matching text highlighted inline. |
16 | | -- **Which code should I use?** — 12 real-world API scenarios (resource created, validation failed, not authenticated, forbidden, rate limited, not found, no-content deletion, async job accepted, permanent redirect, conflicting state, unhandled crash, upstream outage) each mapped to the correct status code with a justification for *why*. |
17 | | -- **Expandable rows** — click any status code to reveal its full description, spec reference, and category. |
18 | | -- **One-click copy** — copy any code as `"404 Not Found"`-style text, ready to paste into code, docs, or a commit message. |
19 | | -- **Persistent state** — your last search term and category filter are remembered between visits via `localStorage`. |
20 | | -- **Dark & light themes**, fully responsive down to 360px, accessible, and keyboard-driven. |
21 | | - |
22 | | -## Installation |
23 | | - |
24 | | -No dependencies, no build step. |
25 | | - |
26 | | -```bash |
27 | | -git clone https://github.com/kasapdev/http-status-code-reference-pro.git |
28 | | -cd http-status-code-reference-pro |
29 | | -``` |
30 | | - |
31 | | -Then simply open `index.html` in any modern browser (double-click it, or `file://` it). That's it. |
32 | | - |
33 | | -## Usage |
34 | | - |
35 | | -1. Browse the **Which code should I use?** panel for common scenarios, or scroll down to the full **Status codes** list. |
36 | | -2. Use the **search box** to find a code by number (`404`) or by keyword (`timeout`, `unauthorized`, `rate limit`). |
37 | | -3. Use the **category tabs** to narrow the list to a single class of status code (1xx–5xx). |
38 | | -4. Click any row to **expand** it and read the full description and spec reference. |
39 | | -5. Click the **copy icon** on a row to copy `"CODE Name"` to your clipboard, or click a scenario's code chip to jump straight to it in the list below. |
40 | | - |
41 | | -## Keyboard Shortcuts |
42 | | - |
43 | | -| Action | Shortcut | |
44 | | -| ----------------------------- | -------- | |
45 | | -| Focus the search box | <kbd>/</kbd> | |
46 | | -| Show 1xx Informational | <kbd>1</kbd> | |
47 | | -| Show 2xx Success | <kbd>2</kbd> | |
48 | | -| Show 3xx Redirection | <kbd>3</kbd> | |
49 | | -| Show 4xx Client Error | <kbd>4</kbd> | |
50 | | -| Show 5xx Server Error | <kbd>5</kbd> | |
51 | | -| Show all categories | <kbd>0</kbd> | |
52 | | -| Show this help | <kbd>?</kbd> | |
53 | | -| Clear search / close dialog | <kbd>Esc</kbd> | |
54 | | - |
55 | | -## Screenshots |
56 | | - |
57 | | -> _Screenshots coming soon._ |
58 | | -
|
59 | | - |
60 | | - |
61 | | - |
62 | | -## Roadmap |
63 | | - |
64 | | -- [ ] Copy-as-code snippets (curl, fetch, or framework-specific error responses) per status code |
65 | | -- [ ] A "compare two codes" side-by-side view for easily confused pairs (401 vs 403, 409 vs 422, 301 vs 308) |
66 | | -- [ ] Filterable by common frameworks' default usage (Express, Django REST, Spring) |
67 | | -- [ ] Shareable deep links that pre-select a search term or category |
68 | | -- [ ] Printable / exportable cheat-sheet (PDF or Markdown) |
69 | | - |
70 | | -## License |
71 | | - |
72 | | -MIT Licensed. Part of the [Web Utility Suite](../index.html). |
0 commit comments