Skip to content

Improve Add a Framework section #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MDA2AV merged 1 commit into from
Feb 13, 2026
Merged

Improve Add a Framework section #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/content/add-a-framework/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Your server must listen on **port 8080** and implement three endpoints:
| Endpoint | Method | Behavior |
|----------|--------|----------|
| `/` | `GET` | Return `200 OK`. This is the baseline reachability check. |
| `/` | `HEAD` | Return `200 OK` with no body. Used by smuggling tests that check body handling on HEAD requests. |
| `/` | `POST` | Read the full request body and return it in the response. Used by body handling and smuggling tests. |
| `/` | `OPTIONS` | Return `200 OK`. Used by smuggling tests that check body handling on OPTIONS requests. |
| `/echo` | `POST` | Return all received request headers in the response body, one per line as `Name: Value`. Used by normalization tests. |

### Why `/echo`?
Expand Down Expand Up @@ -108,3 +110,4 @@ The key parts:
- **`/echo`** — echoes all received headers back as plain text.
- **`POST /`** — reads and returns the request body (needed for body and smuggling tests).
- **`GET /`** (catch-all) — returns `"OK"` with `200`.
- **`HEAD /`** and **`OPTIONS /`** — handled by the catch-all; return `200` so smuggling tests can evaluate body handling instead of getting `405`.
Loading