libhttpserver 技术文档

1. 安装指南

libhttpserver 可以在没有依赖项的情况下使用，除了 libmicrohttpd。

所需的最低版本如下：

• g++ >= 5.5.0 或 clang-3.6
• C++17 或更新版本
• libmicrohttpd >= 0.9.64
• [可选] 对于 TLS（HTTPS）支持，需要 libgnutls
• [可选] 若要编译代码参考，需要 doxygen

此外，对于使用 MinGW 的 Windows 用户，需要：

• libwinpthread（如果你使用 MinGW-w64 并且线程模型为 posix，那么你已经有了这个）

在 0.18.0 版本之前，MinGW 还需要：

• libgnurx >= 2.5.1

测试用例使用 libcurl，但编译库时不需要它。

2. 项目使用说明

以下是一个最基本的创建服务器和处理 /hello 路径请求的示例：

#include <httpserver.hpp>

using namespace httpserver;

class hello_world_resource : public http_resource {
public:
    std::shared_ptr<http_response> render(const http_request&) {
        return std::shared_ptr<http_response>(new string_response("Hello, World!"));
    }
};

int main(int argc, char** argv) {
    webserver ws = create_webserver(8080);

    hello_world_resource hwr;
    ws.register_resource("/hello", &hwr);
    ws.start(true);
    
    return 0;
}

要测试上述示例，你可以在终端运行以下命令：

curl -XGET -v http://localhost:8080/hello

3. 项目API使用文档

libhttpserver 提供了一系列类和接口，以下是一些主要结构体和类的定义：

• webserver: 代表监听 HTTP 流量的守护进程。
  • create_webserver: 构建器类，支持创建服务器。
• http_resource: 代表与特定 HTTP 端点关联的资源。
• http_request: 代表资源处理接收到的请求。
• http_response: 代表服务器发送的响应。
  • string_response: 简单的字符串响应。
  • file_response: 从文件获取内容的响应。
  • basic_auth_fail_response: 基本认证失败的响应。
  • digest_auth_fail_response: 摘要认证失败的响应。
  • deferred_response: 从回调获取内容的响应。

4. 项目安装方式

libhttpserver 使用标准的构建系统，通常的构建过程涉及运行：

./bootstrap
mkdir build
cd build
./configure
make
make install # (可选，用于在系统上安装)

可选参数可以在运行 configure --help 时获得完整列表。这里列出了一些 libhttpserver 特定的选项（支持标准的配置选项）：

• --enable-same-directory-build: 启用在相同目录下编译。强烈不推荐。（默认 = no）
• --enable-debug: 启用调试数据生成。（默认 = no）
• --disable-doxygen-doc: 不生成任何 doxygen 文档。如果系统上有 doxygen 会自动调用，否则自动禁用。
• --enable-fastopen: 启用 TCP_FASTOPEN。（默认 = yes）
• --enable-static: 启用静态链接（默认 = yes）