1. 介紹
在嵌入式應用程序中，有時需要提供一個 WEB 服務，用於對系統進行遠程配置和管理。
awtk-restful-httpd 實現了一個 RESTful HTTP 服務框架，可以幫助開發者快速實現 RESTful API 風格的 WEB 服務。主要特色有：
- 小巧。約 3000 行代碼。
- 簡單。註冊自己路由表處理函數即可。
- 易用。內置路由解析功能，並提供簡單易用的 JSON 讀寫 API。
- 內存開銷低。正常 REST API 內存需求小於 2K，靜態文件內存需求小於 6K。
- 方便嵌入到 AWTK 應用程序。無縫集成到 AWTK 的主循環，無需另外開闢線程。
2 準備
2.1 獲取 awtk 並編譯
git clone https://github.com/zlgopen/awtk.git
cd awtk; scons; cd -
2.2 獲取 awtk-restful-httpd 並編譯
git clone https://github.com/zlgopen/awtk-restful-httpd.git
cd awtk-restful-httpd
- 生成資源
python ./scripts/update_res.py all
或者通過 designer 生成資源
- 編譯 PC 版本
scons
- 編譯 LINUX FB 版本
scons LINUX_FB=true
完整編譯選項請參考 編譯選項
3. 運行
./bin/demo
4. 示例
4.1 定義路由表
static ret_t my_httpd_on_status(http_connection_t* c) {
return RET_OK;
}
static ret_t my_httpd_on_element_action(http_connection_t* c) {
return RET_OK;
}
static const http_route_entry_t s_my_httpd_routes[] = {
{HTTP_GET, "/status", my_httpd_on_status},
{HTTP_GET, "element/:element/:action", my_httpd_on_element_action}
};
4.2 靜態文件
內置提供了靜態文件的處理，支持靜態文件處理相當容易。
static ret_t my_httpd_on_get_file(http_connection_t* c) {
return http_route_handle_static_file(c, "static");
}
"static"在這裏表示靜態文件所在的目錄。
路由匹配規則用“*”表示缺省路由，放到最後一項，用來處理靜態文件。
{HTTP_GET, "*", my_httpd_on_get_file},
完整示例請參考：demos/app_main.c
4.3 靜態文件傳輸優化
有些大的文件，特別是文本文件，可以壓縮之後傳輸，能大大提供傳輸效率。爲了避免運行時壓縮帶來的內存和 CPU 開銷，可以預先壓縮文件，並以.gz 文件命名。
比如請求 static/js/awtk_asm.wasm 文件時，如果存在 static/js/awtk_asm.wasm.gz，那麼就返回 static/js/awtk_asm.wasm.gz 給客戶端，並設置 Content-Encoding，瀏覽器會自動解壓。
Content-Encoding: gzip
4.4 啓動服務
ret_t my_httpd_start(httpd_t* httpd) {
return_value_if_fail(httpd != NULL, RET_BAD_PARAMS);
httpd_set_routes(httpd, s_my_httpd_routes, ARRAY_SIZE(s_my_httpd_routes));
return httpd_start(httpd);
}
awtk-ui-automation 是 awtk-restful-httpd 的第一個應用，可以作爲示例代碼參考。 ·