diff --git a/docs/api.md b/docs/api.md index bd55c61..2038bf1 100644 --- a/docs/api.md +++ b/docs/api.md @@ -37,7 +37,7 @@ |session | 当前连接会话结构体指针 | |URI | 连接的 HTTP 服务器地址 | | **返回** | **描述** | -|>0 | HTTP 响应状态码 | +|`>0` | HTTP 响应状态码 | |<0 | 发送请求失败 | ## 发送获取部分数据的 GET 请求 @@ -52,7 +52,7 @@ |URI | 连接的 HTTP 服务器地址 | |position | 数据偏移量 | | **返回** | **描述** | -|>0 | HTTP 响应状态码 | +|`>0` | HTTP 响应状态码 | |<0 | 发送请求失败 | ## 发送 POST 请求 @@ -67,7 +67,7 @@ |URI | 连接的 HTTP 服务器地址 | |post_data | 需要上传的数据地址 | | **返回** | **描述** | -|>0 | HTTP 响应状态码 | +|`>0` | HTTP 响应状态码 | |<0 | 发送请求失败 | ## 发送数据 @@ -82,7 +82,7 @@ |buffer | 发送数据的地址 | |size | 发送数据的长度 | | **返回** | **描述** | -|>0 | 成功发送数据的长度 | +|`>0` | 成功发送数据的长度 | |=0 | 连接关闭 | |<0 | 发送数据失败 | @@ -98,7 +98,7 @@ |buffer | 接收数据的存放地址 | |size | 最大接收数据的长度 | | **返回** | **描述** | -|>0 | 成功接收数据的长度 | +|`>0` | 成功接收数据的长度 | |=0 | 连接关闭 | |<0 | 接收数据失败 | @@ -126,9 +126,9 @@ |:------------------|:-----------------------------------| |session | 当前连接会话结构体指针 | |fmt | 添加字段数据的表达式 | -|... | 添加的字段数据，为可变参数 | +|... | 添加的字段数据，为可变参数 | | **返回** | **描述** | -| >0 | 成功添加的字段数据的长度 | +|`>0` | 成功添加的字段数据的长度 | | <=0 | 添加失败或者头部数据长度超出 | ## 通过字段名获取字段值数据 @@ -157,12 +157,13 @@ |session | 当前连接会话结构体指针 | |response | 存放接收数据的字符串地址 | | **返回** | **描述** | -| >0 | 成功接收数据的长度 | +| `>0` | 成功接收数据的长度 | | <=0 | 接收数据失败 | ## 发送 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);` | 参数 | 描述 | |:------------------|:-----------------------------------| @@ -173,9 +174,9 @@ |post_data | 发送到服务器的数据 | | | = NULL，该发送请求为 GET 请求 | | | != NULL，该发送请求为 POST 请求 | -|response | 存放接收数据的字符串地址 | +|response | 存放接收数据的字符串地址 | | **返回** | **描述** | -| >0 | 成功接收数据的长度 | +| `>0` | 成功接收数据的长度 | | <=0 | 接收数据失败 | @@ -201,7 +202,7 @@ |:------------------|:-----------------------------------| |session | 当前连接会话结构体指针 | | **返回** | **描述** | -| >0 | Content-Length 字段数据 | +| `>0` | Content-Length 字段数据 | | <0 | 获取失败 | ## 下载文件到本地 diff --git a/docs/introduction.md b/docs/introduction.md index 758d3bf..9411f65 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -6,25 +6,25 @@ WebClient 软件包是 RT-Thread 自主研发的，基于 HTTP 协议的客户 WebClient 软件包目录结构如下所示： -``` +```shell webclient -├───docs -│ └───figures // 文档使用图片 ++---docs +│ +---figures // 文档使用图片 │ │ api.md // API 使用说明 │ │ introduction.md // 介绍文档 │ │ principle.md // 实现原理 -│ │ README.md // 文档结构说明 +│ │ README.md // 文档结构说明 │ │ samples.md // 软件包示例 │ │ user-guide.md // 使用说明 -│ └───version.md // 版本 -├───inc // 头文件 -├───src // 源文件 -├───samples // 示例代码 -| | webclient_get_sample // GET 请求示例代码 -│ └───webclient_post_sample // POST 请求示例代码 +│ +---version.md // 版本 ++---inc // 头文件 ++---src // 源文件 ++---samples // 示例代码 +│ │ webclient_get_sample // GET 请求示例代码 +│ +---webclient_post_sample // POST 请求示例代码 │ LICENSE // 软件包许可证 │ README.md // 软件包使用说明 -└───SConscript // RT-Thread 默认的构建脚本 ++---SConscript // RT-Thread 默认的构建脚本 ``` ## 软件包功能特点 diff --git a/docs/samples.md b/docs/samples.md index c968b93..ac91321 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -52,7 +52,7 @@ GET 请求示例使用方式有如下两种： - 在 MSH 中使用命令 `web_get_test` 执行 GET 请求示例程序，可以获取并打印显示默认网址下载的文件信息，如下图 LOG 显示： -```shell +```c msh />web_get_test webclient GET request response data : RT-Thread is an open source IoT operating system from China, which has strong scalability: from a tiny kernel running on a tiny core, for example ARM Cortex-M0, or Cortex-M3/4/7, to a rich feature system running on MIPS32, ARM Cortex-A8, ARM Cortex-A9 DualCore etc. @@ -77,7 +77,7 @@ POST 请求示例使用方式有如下两种： - 在 MSH 中使用命令 `web_post_test` 执行 POST 请求示例程序，可以获取并打印显示响应数据（默认 POST 请求的地址是类似于回显的地址，会返回上传的数据），如下图 LOG 显示： -```shell +```c msh />web_post_test webclient POST request response data : RT-Thread is an open source IoT operating system from China! diff --git a/docs/user-guide.md b/docs/user-guide.md index 1d017c9..e1bec1c 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -10,7 +10,7 @@ 详细配置介绍如下所示： -``` +```shell RT-Thread online packages IoT - internet of things ---> [*] WebClient: A HTTP/HTTPS Client for RT-Thread @@ -34,7 +34,7 @@ RT-Thread online packages 1. **创建客户端会话结构体** -``` +```c struct webclient_header { char *buffer; //添加或者获取的头部数据