Skip to content

Commit 47fc633

Browse files
misonyomisonyo
committed
[更新]文档格式调整
1 parent f86c740 commit 47fc633

7 files changed

Lines changed: 115 additions & 74 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ WebNet 软件包遵循 GPL2+ 商业双许可。该软件包可以根据 GNU 标
4646

4747
使用 WebNet软件包需要在 RT-Thread 的包管理中选中它，具体路径如下：
4848

49-
```shell
49+
```c
5050
RT-Thread online packages
5151
IoT - internet of things --->
5252
[*] WebNet: A HTTP Server for RT-Thread
@@ -95,7 +95,7 @@ RT-Thread online packages
9595
## 4、注意事项
9696
9797
- WebNet 软件包使用需要文件系统支持，需要确保运行设备上能使用文件系统。
98-
- WebNet 软件包默认未开启任何模块功能支持，使用的需要根据[软件包介绍](docs/introduction.md)在 ENV 中开启需要的功能。
98+
- WebNet 软件包默认未开启任何模块功能支持，使用的需要根据[软件包介绍](docs/introduction.md)在 Env 中开启需要的功能。
9999
100100
## 5、联系方式 & 感谢
101101

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## 文档列表
88

9-
|文件名 |描述|
9+
|**文件名** |**描述**|
1010
|:----- |:----|
1111
|[version.md](version.md) |版本信息|
1212
|[introduction.md](introduction.md) |详细介绍|

‎docs/api.md‎

Lines changed: 90 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,233 +4,269 @@
44

55
## 初始化函数
66

7-
> int webnet_init(void);
7+
```c
8+
int webnet_init(void);
9+
```
810
911
用于初始化 WebNet 服务器，包括创建线程用于监听客户端连接事件、初始化开启的功能模块等功能；
1012
11-
| 参数 | 描述 |
13+
|**参数** | **描述** |
1214
| :------- | :--------- |
1315
| 无 | 无 |
14-
| **返回** | **描述** |
16+
| **返回** | **--** |
1517
| = 0 | 初始化成功 |
1618
| < 0 | 初始化失败 |
1719
1820
## 设置监听套接字端口
1921
20-
> void webnet_set_port(int port);
22+
```c
23+
void webnet_set_port(int port);
24+
```
2125

2226
用于设置当前 WebNet 服务器监听端口号，WebNet 服务器默认监听端口号是 80，这也是 HTTP 协议默认端口号。使用默认端口号访问 URL 地址时可以不输入端口号直接访问，当使用非默认端口号时，需要在 URL 地址上指明端口号，如：`http://host:8080/index.html` 。该函数只能**用于 WebNet 服务器初始化之前**。
2327

24-
| 参数 | 描述 |
28+
|**参数** | **描述** |
2529
| :------- | :------------------- |
2630
| port | 设置的监听套接字端口 |
27-
| **返回** | **描述** |
31+
| **返回** | **--** |
2832
| 无 | 无 |
2933

3034
## 获取监听套接字端口
3135

32-
> int webnet_get_port(void);
36+
```c
37+
int webnet_get_port(void);
38+
```
3339
3440
用于获取当前 WebNet 服务器监听套接字端口号。
3541
36-
| 参数 | 描述 |
42+
|**参数** | ****描述**** |
3743
| :------- | :--------------- |
3844
| 无 | 无 |
39-
| **返回** | **描述** |
45+
| **返回** | **--** |
4046
| >=0 | 监听套接字端口号 |
4147
4248
## 设置服务器根目录
4349
44-
> void webnet_set_root(const char* webroot_path);
50+
```c
51+
void webnet_set_root(const char* webroot_path);
52+
```
4553

4654
用于设置当前 WebNet 服务器根目录路径，WebNet 服务器默认根目录为 `/webnet`，浏览器和 WebNet 函数中使用或访问的路径都是基于根目录路径。当浏览器访问 `http://host/index.html` 时，会把文件系统中的 `/webnet/index.html` 返回给浏览器。
4755

48-
| 参数 | 描述 |
56+
|**参数** | **描述** |
4957
| :----------- | :--------------- |
5058
| webroot_path | 设置的根目录地址 |
51-
| **返回** | **描述** |
59+
| **返回** | **--** |
5260
| 无 | 无 |
5361

5462
## 获取服务器根目录
5563

56-
> const char* webnet_get_root(void);
64+
```c
65+
const char* webnet_get_root(void);
66+
```
5767
5868
用于获取当前 WebNet 服务器根目录地址。
5969
60-
| 参数 | 描述 |
70+
|**参数** | **描述** |
6171
| :------- | :--------- |
6272
| 无 | 无 |
63-
| **返回** | **描述** |
73+
| **返回** | **--** |
6474
| != NULL | 根目录地址 |
6575
6676
## 获取请求链接的类型
6777
68-
> const char* mime_get_type(const char* url);
78+
```c
79+
const char* mime_get_type(const char* url);
80+
```
6981

7082
用于获取当前请求 URL 链接的类型，如：网页、图片、文本等。
7183

72-
| 参数 | 描述 |
84+
|**参数** | **描述** |
7385
| :------- | :------------- |
7486
| url | 请求链接的地址 |
75-
| **返回** | **描述** |
87+
| **返回** | **--** |
7688
| != NULL | 请求链接的类型 |
7789

7890
## 添加 ASP 变量处理方式
7991

80-
> void webnet_asp_add_var(const char* name, void (*handler)(struct webnet_session* session));
92+
```c
93+
void webnet_asp_add_var(const char* name, void (*handler)(struct webnet_session* session));
94+
```
8195
8296
该函数用于添加一个 ASP 变量处理方式，当 ASP 文件中出现添加的 `name` 变量名时，会执行对应的 `handle` 操作。
8397
84-
| 参数 | 描述 |
98+
|**参数** | **描述** |
8599
| :---------------------------------------------- | :--------------- |
86100
| name | ASP 变量名称 |
87101
| void (*handler)(struct webnet_session* session) | ASP 变量处理方式 |
88-
| **返回** | **描述** |
102+
| **返回** | **--** |
89103
| 无 | 无 |
90104
91105
## 添加 CGI 事件处理方式
92106
93-
> void webnet_cgi_register(const char* name, void (*handler)(struct webnet_session* session));
107+
```c
108+
void webnet_cgi_register(const char* name, void (*handler)(struct webnet_session* session));
109+
```
94110

95111
该函数用于注册一个 CGI 事件处理方式，当浏览器请求带有 `name` 名称的 URL 时，会执行相应的 `handle` 操作。
96112

97-
| 参数 | 描述 |
113+
|**参数** | **描述** |
98114
| :---------------------------------------------- | :--------------- |
99115
| name | CGI 事件名称 |
100116
| void (*handler)(struct webnet_session* session) | CGI 事件处理方式 |
101-
| **返回** | **描述** |
117+
| **返回** | **--** |
102118
| 无 | 无 |
103119

104120
## 设置 CGI 事件根目录
105121

106-
> void webnet_cgi_set_root(const char* root);
122+
```c
123+
void webnet_cgi_set_root(const char* root);
124+
```
107125
108126
WebNet 服务器默认的 CGI 事件根目录为`/cgi-bin`，当浏览器请求 `http://host/cgi-bin/test` 地址时，会执行 `test` 名称对应的 CGI 事件处理函数。
109127
110128
该函数用于设置新的 CGI 事件根目录，设置成功之前的 CGI 根目录将不再起作用。
111129
112-
| 参数 | 描述 |
130+
|**参数** | **描述** |
113131
| :------- | :------------- |
114132
| root | CGI 事件根目录 |
115-
| **返回** | **描述** |
133+
| **返回** | **--** |
116134
| 无 | 无 |
117135
118136
## 设置基本认证信息
119137
120-
> void webnet_auth_set(const char* path, const char* username_password);
138+
```c
139+
void webnet_auth_set(const char* path, const char* username_password);
140+
```
121141

122142
用于设置目录访问时的基本认证信息，包括用户名和密码。
123143

124-
| 参数 | 描述 |
144+
|**参数** | **描述** |
125145
| :---------------- | :--------------------------------------------- |
126146
| path | 需要设置基本认证信息的目录 |
127147
| username_password | 设置的用户名和密码，格式为 `username:password` |
128-
| **返回** | **描述** |
148+
| **返回** | **--** |
129149
| 无 | 无 |
130150

131151
## 设置目录别名
132152

133-
> void webnet_alias_set(char* old_path, char* new_path);
153+
```c
154+
void webnet_alias_set(char* old_path, char* new_path);
155+
```
134156
135157
用于设置目录的别名，设置成功之后可以使用目录别名访问该目录。
136158
137-
| 参数 | 描述 |
159+
|**参数** | **描述** |
138160
| :------- | :--------------------------------------- |
139161
| old_path | 需要设置别名的目录 |
140162
| new_path | 设置的目录别名，一般为服务器中存在的目录 |
141-
| **返回** | **描述** |
163+
| **返回** | **--** |
142164
| 无 | 无 |
143165
144166
## 发送 HTTP 请求头部
145167
146-
> void webnet_session_set_header(struct webnet_session* session, const char* mimetype, int code, const char* title, int length);
168+
```c
169+
void webnet_session_set_header(struct webnet_session* session, const char* mimetype, int code, const char* title, int length);
170+
```
147171

148172
用于拼接并发送头部信息到连接的客户端，一般用于 ASP 变量处理函数和 CGI 事件处理函数中。
149173

150-
| 参数 | 描述 |
174+
|**参数** | **描述** |
151175
| :------- | :----------------------------------------------------------- |
152176
| session | 当前服务器连接的会话 |
153177
| mimetype | 需要发送的响应文件类型（Content-Type），可以使用 `mime_get_type` 函数获取 |
154178
| code | 发送的响应状态码，正常为 200 |
155179
| title | 发送的响应状态类型，正常为 OK |
156180
| length | 需要发送的响应文件长度（Content-Length） |
157-
| **返回** | **描述** |
181+
| **返回** | **--** |
158182
| 无 | 无 |
159183

160184
## 发送 HTTP 响应数据
161185

162-
> int webnet_session_write(struct webnet_session* session, const rt_uint8_t* data, rt_size_t size);
186+
```c
187+
int webnet_session_write(struct webnet_session* session, const rt_uint8_t* data, rt_size_t size);
188+
```
163189
164190
用于发送响应数据到客户端，一般用于 ASP 变量处理函数和 CGI 事件处理函数中。
165191
166-
| 参数 | 描述 |
192+
|**参数** | **描述** |
167193
| :------- | :------------------- |
168194
| session | 当前服务器连接的会话 |
169195
| data | 发送的数据指针 |
170196
| size | 发送的数据长度 |
171-
| **返回** | **描述** |
197+
| **返回** | **--** |
172198
| 无 | 无 |
173199
174200
175201
## 发送 HTTP 固定格式响应数据
176202
177-
> void webnet_session_printf(struct webnet_session* session, const char* fmt, ...);
203+
```c
204+
void webnet_session_printf(struct webnet_session* session, const char* fmt, ...);
205+
```
178206

179207
用于发送固定格式的响应数据到客户端，一般用于 ASP 变量处理函数和 CGI 事件处理函数中。
180208

181-
| 参数 | 描述 |
209+
|**参数** | **描述** |
182210
| :------- | :----------------------- |
183211
| session | 当前服务器连接的会话 |
184212
| fmt | 自定义的输入数据的表达式 |
185213
| ... | 输入的参数 |
186-
| **返回** | **描述** |
214+
| **返回** | **--** |
187215
| 无 | 无 |
188216

189217
## 获取上传文件的名称
190218

191-
> const char* webnet_upload_get_filename(struct webnet_session* session);
219+
```c
220+
const char* webnet_upload_get_filename(struct webnet_session* session);
221+
```
192222
193223
获取当前上传文件的名称，用于打开或创建文件。
194224
195-
| 参数 | 描述 |
225+
|**参数** | **描述** |
196226
| :------- | :------------------- |
197227
| session | 当前服务器连接的会话 |
198-
| **返回** | **描述** |
228+
| **返回** | **--** |
199229
| != NULL | 当前上传文件的名称 |
200230
201231
## 获取上传文件的类型
202232
203-
> const char* webnet_upload_get_content_type(struct webnet_session* session);
233+
```c
234+
const char* webnet_upload_get_content_type(struct webnet_session* session);
235+
```
204236

205237
获取当前上传文件的类型。
206238

207-
| 参数 | 描述 |
239+
|**参数** | **描述** |
208240
| :------- | :------------------- |
209241
| session | 当前服务器连接的会话 |
210-
| **返回** | **描述** |
242+
| **返回** | **--** |
211243
| != NULL | 当前上传文件的类型 |
212244

213245
## 获取上传文件参数
214246

215-
> const char* webnet_upload_get_nameentry(struct webnet_session* session, const char* name);
247+
```c
248+
const char* webnet_upload_get_nameentry(struct webnet_session* session, const char* name);
249+
```
216250
217251
获取注册的上传文件的分隔符（HTTP 请求 boundary 参数）。
218252
219-
| 参数 | 描述 |
253+
|**参数** | **描述** |
220254
| :------- | :------------------- |
221255
| session | 当前服务器连接的会话 |
222256
| name | 上传文件的目录路径 |
223-
| **返回** | **描述** |
257+
| **返回** | **--** |
224258
| != NULL | 当前上传文件的类型 |
225259
226260
## 获取上传文件打开的文件描述符
227261
228-
> const void* webnet_upload_get_userdata(struct webnet_session* session);
262+
```c
263+
const void* webnet_upload_get_userdata(struct webnet_session* session);
264+
```
229265

230266
获取当前上传文件打开之后生成的文件描述符，用于读写数据到文件中。
231267

232-
| 参数 | 描述 |
268+
|**参数** | **描述** |
233269
| :------- | :----------------------- |
234270
| session | 当前服务器连接的会话 |
235-
| **返回** | **描述** |
271+
| **返回** | **--** |
236272
| != NULL | 上传文件打开的文件描述符 |

‎docs/introduction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ WebNet 软件包是 RT-Thread 自主研发的，基于 HTTP 协议的 Web 服务
66

77
WebClient 软件包目录结构如下所示：
88

9-
| 名称 | 说明 |
9+
| **名称** | **说明** |
1010
| ---------- | ------------------------ |
1111
| docs | 文档目录 |
1212
| inc | 头文件目录 |

0 commit comments

Comments
 (0)