mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-09-03 15:23:47 +00:00
254e576b50
* Add Server::CustomRoute() for HTTP methods outside the built-in set parse_request_line validates the request method against a fixed whitelist and rejects anything else with 400 before routing runs. That blocks WebDAV, where PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK and UNLOCK are ordinary methods defined by RFC 4918, and it blocks extension methods such as UPnP's SUBSCRIBE. The need has been open since #847. Registering a handler is now what makes the server accept a method: svr.CustomRoute("PROPFIND", "/dav/:id", handler); Because custom methods go through the normal dispatch path, patterns work the way they do for Get() and friends, and the request body is available in req.body. Serving these methods through set_pre_routing_handler was never enough: the body has not been read at that point, so PROPPATCH and LOCK, which require one, could not be implemented at all. A HandlerWithContentReader overload is available too. The content reader gate in routing() also fires when a custom method carries no body, matching what expect_content() does unconditionally for POST/PUT/PATCH/DELETE, so a body-less PROPFIND (RFC 4918 treats one as allprop) reaches its handler instead of falling through to 404. Method names are validated as RFC 9110 tokens, and the ten built-in methods are refused. Seven of them are dispatched by the if/else chain in routing() before the custom tables are consulted, so a route registered for one could never fire; CONNECT, TRACE and PRI carry protocol-level meaning this library does not route. A refused registration makes is_valid() return false, so listen() fails rather than starting a server holding a handler that would never run. This is also why SSLServer::is_valid() now chains to Server::is_valid() instead of only checking ctx_. Servers that never call CustomRoute() keep the previous per-request cost: the built-in method set is checked first and short-circuits, and the custom lookup returns early on an empty map. * Add cookbook recipe for custom HTTP methods The CustomRoute() docs were a section inside S01, which pushed that page to 90 lines, the longest in the cookbook, and mixed a separate feature into a page about registering GET/POST/PUT/DELETE handlers. Move the section into its own recipe and give it room for the part that was missing: the OPTIONS handler returning DAV: and Allow, which WebDAV clients probe for before anything else. S01 goes back to 68 lines and keeps a pointer to the new page. The recipe is titled after the API rather than after WebDAV, and says outright that generating the 207 Multi-Status XML, interpreting Depth and managing locks are the reader's job. Routing the method is all the library does. S23 takes order 42, so the TLS, SSE and WebSocket recipes shift to 43-57. That only moves the sort key. Filenames, the T01/E01/W01 labels, the published URLs and every cross-reference are untouched.
69 lines
2.8 KiB
Markdown
69 lines
2.8 KiB
Markdown
---
|
|
title: "S01. GET / POST / PUT / DELETEハンドラを登録する"
|
|
order: 20
|
|
status: "draft"
|
|
---
|
|
|
|
`httplib::Server`では、HTTPメソッドごとにハンドラを登録します。`Get()`、`Post()`、`Put()`、`Delete()`の各メソッドにパターンとラムダを渡すだけです。WebDAVの`PROPFIND`のような組み込み以外のメソッドを扱いたいときは、`CustomRoute()`を使います。
|
|
|
|
## 基本の使い方
|
|
|
|
```cpp
|
|
#include <httplib.h>
|
|
|
|
int main() {
|
|
httplib::Server svr;
|
|
|
|
svr.Get("/hello", [](const httplib::Request &req, httplib::Response &res) {
|
|
res.set_content("Hello, World!", "text/plain");
|
|
});
|
|
|
|
svr.Post("/api/items", [](const httplib::Request &req, httplib::Response &res) {
|
|
// req.bodyにリクエストボディが入っている
|
|
res.status = 201;
|
|
res.set_content("Created", "text/plain");
|
|
});
|
|
|
|
svr.Put("/api/items/1", [](const httplib::Request &req, httplib::Response &res) {
|
|
res.set_content("Updated", "text/plain");
|
|
});
|
|
|
|
svr.Delete("/api/items/1", [](const httplib::Request &req, httplib::Response &res) {
|
|
res.status = 204;
|
|
});
|
|
|
|
svr.listen("0.0.0.0", 8080);
|
|
}
|
|
```
|
|
|
|
ハンドラは`(const Request&, Response&)`の2引数を受け取ります。`res.set_content()`でレスポンスボディとContent-Typeを設定し、`res.status`でステータスコードを指定します。`listen()`を呼ぶとサーバーが起動し、ブロックされます。
|
|
|
|
## クエリパラメーターを取得する
|
|
|
|
```cpp
|
|
svr.Get("/search", [](const httplib::Request &req, httplib::Response &res) {
|
|
auto q = req.get_param_value("q");
|
|
auto limit = req.get_param_value("limit");
|
|
res.set_content("q=" + q + ", limit=" + limit, "text/plain");
|
|
});
|
|
```
|
|
|
|
`req.get_param_value()`でクエリ文字列の値を取り出せます。存在するかどうかを先に調べたいなら`req.has_param("q")`を使います。
|
|
|
|
## リクエストヘッダーを読む
|
|
|
|
```cpp
|
|
svr.Get("/me", [](const httplib::Request &req, httplib::Response &res) {
|
|
auto ua = req.get_header_value("User-Agent");
|
|
res.set_content("UA: " + ua, "text/plain");
|
|
});
|
|
```
|
|
|
|
レスポンスヘッダーを追加したいときは`res.set_header("Name", "Value")`です。
|
|
|
|
> **Note:** `listen()`はブロックする関数です。別スレッドで動かしたいときは`std::thread`で包むか、ノンブロッキング起動が必要なら[S18. `listen_after_bind`で起動順序を制御する](../s18-listen-after-bind)を参照してください。
|
|
|
|
> パスパラメーター（`/users/:id`）を使いたい場合は[S03. パスパラメーターを使う](../s03-path-params)を参照してください。
|
|
|
|
> WebDAVの`PROPFIND`のような組み込み以外のメソッドは[S23. カスタムHTTPメソッドを扱う](../s23-custom-methods)を参照してください。
|