add: 为httpsrv库添加API注释

components/network/httpsrv/src/luat_lib_httpsrv.c

@@ -1,9 +1,49 @@
+/*
+@module  httpsrv
+@summary http服务端
+@version 1.0
+@date    2022.010.15
+@demo network
+*/
+
 #include "luat_base.h"
 #include "luat_httpsrv.h"
 
 #define LUAT_LOG_TAG "httpsrv"
 #include "luat_log.h"
 
+/*
+启动并监听一个http端口
+@api httpsrv.start(port, func)
+@int 端口号
+@function 回调函数
+@return bool 成功返回true, 否则返回false
+@usage
+
+-- 监听80端口
+httpsrv.start(80, function(client, method, uri, headers, body)
+    -- method 是字符串, 例如 GET POST PUT DELETE
+    -- uri 也是字符串 例如 / /api/abc
+    -- headers table类型
+    -- body 字符串
+    log.info("httpsrv", method, uri, json.encode(headers), body)
+    if uri == "/led/1" then
+        LEDA(1)
+        return 200, {}, "ok"
+    elseif uri == "/led/0" then
+        LEDA(0)
+        return 200, {}, "ok"
+    end
+    -- 返回值的约定 code, headers, body
+    -- 若没有返回值, 则默认 404, {} ,""
+    return 404, {}, "Not Found" .. uri
+end)
+-- 关于静态文件
+-- 情况1: / , 映射为 /index.html
+-- 情况2: /abc.html , 先查找 /abc.html, 不存在的话查找 /abc.html.gz
+-- 若gz存在, 会自动以压缩文件进行响应, 绝大部分浏览器支持.
+-- 当前默认查找 /luadb/xxx 下的文件,暂不可配置
+*/
 static int l_httpsrv_start(lua_State *L) {
     int port = luaL_checkinteger(L, 1);
     if (!lua_isfunction(L, 2)) {
@@ -17,9 +57,16 @@ static int l_httpsrv_start(lua_State *L) {
         .lua_ref_id = lua_ref_id
     };
     int ret = luat_httpsrv_start(&ctx);
-    return 0;
+    lua_pushboolean(L, ret == 0 ? 1 : 0);
+    return 1;
 }
 
+/*
+停止http服务
+@api httpsrv.stop(port)
+@int 端口号
+@return nil 当前无返回值
+*/
 static int l_httpsrv_stop(lua_State *L) {
     int port = luaL_checkinteger(L, 1);
     luat_httpsrv_stop(port);
@@ -37,4 +84,4 @@ static const rotable_Reg_t reg_httpsrv[] =
 LUAMOD_API int luaopen_httpsrv( lua_State *L ) {
     luat_newlib2(L, reg_httpsrv);
     return 1;
-}
+}