Эх сурвалжийг харах

【修改】UM API 文件显示格式

Signed-off-by: chenyong <1521761801@qq.com>
chenyong 7 жил өмнө
parent
commit
5ab94b5c42
1 өөрчлөгдсөн 17 нэмэгдсэн , 18 устгасан
  1. 17 18
      docs/api.md

+ 17 - 18
docs/api.md

@@ -2,7 +2,7 @@
 
 ## 创建会话
 
-`struct webclient_session *webclient_session_create(size_t header_sz);`
+> struct webclient_session *webclient_session_create(size_t header_sz);
 
 创建客户端会话结构体。
 
@@ -15,7 +15,7 @@
 
 ## 关闭会话连接
 
-`int webclient_close(struct webclient_session *session);`
+> int webclient_close(struct webclient_session *session);
 
 关闭传入的客户端会话连接,并释放内存。
 
@@ -28,7 +28,7 @@
 
 ## 发送 GET 请求
 
-`int webclient_get(struct webclient_session *session, const char *URI);`
+> int webclient_get(struct webclient_session *session, const char *URI);
 
 发送 HTTP GET 请求命令。
 
@@ -42,7 +42,7 @@
 
 ## 发送获取部分数据的 GET 请求
 
-`int webclient_get_position(struct webclient_session *session, const char *URI, int position);`
+> int webclient_get_position(struct webclient_session *session, const char *URI, int position);
 
 发送带有 Range 头信息的 HTTP GET 请求命令,多用于完成断点续传功能。
 
@@ -57,7 +57,7 @@
 
 ## 发送 POST 请求
 
-`int webclient_post(struct webclient_session *session, const char *URI, const char *post_data);`
+> int webclient_post(struct webclient_session *session, const char *URI, const char *post_data);
 
 发送 HTTP POST 请求命令,上传数据到 HTTP 服务器。
 
@@ -72,7 +72,7 @@
 
 ## 发送数据
 
-`int webclient_write(struct webclient_session *session, const unsigned char *buffer, size_t size);`
+> int webclient_write(struct webclient_session *session, const unsigned char *buffer, size_t size);
 
 发送数据到连接的服务器。
 
@@ -88,7 +88,7 @@
 
 ## 接收数据
 
-`int webclient_read(struct webclient_session *session, unsigned char *buffer, size_t size);`
+> int webclient_read(struct webclient_session *session, unsigned char *buffer, size_t size);
 
 从连接的服务器接收数据。
 
@@ -105,7 +105,7 @@
 
 ## 设置接收和发送数据超时时间
 
-`int webclient_set_timeout(struct webclient_session *session, int millisecond);`
+> int webclient_set_timeout(struct webclient_session *session, int millisecond);
 
 设置连接的接收和发送数据超时时间。
 
@@ -118,7 +118,7 @@
 
 ## 在请求头中添加字段数据
 
-`int webclient_header_fields_add(struct webclient_session *session, const char *fmt, ...);`
+> int webclient_header_fields_add(struct webclient_session *session, const char *fmt, ...);
 
 该函数用于创建会话之后和发送 GET 或 POST 请求之前,用于添加请求头字段数据。
 
@@ -133,7 +133,7 @@
 
 ## 通过字段名获取字段值数据
 
-`const char *webclient_header_fields_get(struct webclient_session *session, const char *fields);`
+> const char *webclient_header_fields_get(struct webclient_session *session, const char *fields);
 
 该函数用于发送 GET 或 POST 请求之后,可以通过传入的字段名称获取对应的字段数据。
 
@@ -148,7 +148,7 @@
 
 ## 接收响应数据到指定地址
 
-`int webclient_response(struct webclient_session *session, unsigned char **response);`
+> int webclient_response(struct webclient_session *session, unsigned char **response);
 
 该函数用于发送 GET 或 POST 请求之后, 可以接收响应数据到指定地址。
 
@@ -162,8 +162,7 @@
 
 ## 发送 GET/POST 请求并接收响应数据
 
-`int webclient_request(const char *URI, const char *header, const char *post_data, 
-    unsigned char **response);`
+> int webclient_request(const char *URI, const char *header, const char *post_data, unsigned char **response);
 
 | 参数              | 描述                                |
 |:------------------|:-----------------------------------|
@@ -182,7 +181,7 @@
 
 ## 获取 HTTP 响应状态码
 
-`int webclient_resp_status_get(struct webclient_session *session);`
+> int webclient_resp_status_get(struct webclient_session *session);
 
 该函数用于发送 GET 或 POST 请求之后,用于获取返回的响应状态码。
 
@@ -190,11 +189,11 @@
 |:------------------|:-----------------------------------|
 |session            | 当前连接会话结构体指针               |
 | **返回**          | **描述**                           |
-| >0                | HTTP 响应状态码                     |
+| `>0`              | HTTP 响应状态码                     |
 
 ## 获取 Content-Length 字段数据
 
-`int webclient_content_length_get(struct webclient_session *session);`
+> int webclient_content_length_get(struct webclient_session *session);
 
 该函数用于发送 GET 或 POST 请求之后,用于获取返回的 Content-Length 字段数据。
 
@@ -207,7 +206,7 @@
 
 ## 下载文件到本地
 
-`int webclient_get_file(const char *URI, const char *filename);`
+> int webclient_get_file(const char *URI, const char *filename);
 
 从 HTTP 服务器下载文件并存放到本地。
 
@@ -221,7 +220,7 @@
 
 ## 上传文件到服务器
 
-`int webclient_post_file(const char *URI, const char *filename, const char *form_data);`
+> int webclient_post_file(const char *URI, const char *filename, const char *form_data);
 
 从 HTTP 服务器下载文件并存放到本地。