diff --git a/docs/sbs/zh/sbs/http.md b/docs/sbs/zh/sbs/http.md index f5cd2bc69e4c01f1ab36a8d05402db8612a3163a..fc4412ceb2651378facfe56ce1daa3d490aa9091 100644 --- a/docs/sbs/zh/sbs/http.md +++ b/docs/sbs/zh/sbs/http.md @@ -1,11 +1,11 @@ -# HTTP应用 开发指导 +# HTTP应用开发指导 ## HTTP协议基础 ### HTTP协议 HTTP协议是用于从万维网服务器传输超文本到本地浏览器的传送协议。基于TCP的应用层协议，它不关心数据传输的细节，HTTP（超文本传输协议）是一个基于请求与响应模式的、无状态的、应用层的协议，只有遵循统一的HTTP请求格式，服务器才能正确解析不同客户端发的请求，同样地，服务器遵循统一的响应格式，客户端才得以正确解析不同网站发过来的响应。 -![Client与Server通信](media/de988b13c542b7f454d13cc183693d82.png) +![Client与Server通信](media/QuecPytgon_sbs_http_08.png) ## HTTP请求 @@ -95,174 +95,45 @@ address格式：https://host:port/path?xxx=aaa&ooo=bbb 其中： -- http/https：这个是协议类型 +- http/https：这个是协议类型； -- host：服务器的IP地址或者域名 +- host：服务器的IP地址或者域名； -- port：HTTP服务器的端口，默认端口是80 +- port：HTTP服务器的端口，默认端口是80； -- path：访问资源的路径 +- path：访问资源的路径； -- address里面的？这个符号是个分割线，用来区分问号前面的是path，问号后面的是参数 +- address里面的？这个符号是个分割线，用来区分问号前面的是path，问号后面的是参数； -- address-params：问号后面的是请求参数，格式：xxx=aaa。多个参数用&符号连接 +- address-params：问号后面的是请求参数，格式：xxx=aaa。多个参数用&符号连接。 ## HTTP协议请求方法 HTTP1.0定义了三种请求方法：GET、POST和HEAD方法。HTTP1.1新增了五种请求方法：OPTIONS、PUT、DELETE、TRACE和CONNECT方法。 -- GET：请求指定的页面信息，并返回实体主体。 +- GET：请求指定的页面信息，并返回实体主体； -- POST：向指定资源提交数据进行处理请求，数据被包含在请求体中。 +- POST：向指定资源提交数据进行处理请求，数据被包含在请求体中； -- HEAD：返回的响应中没有具体的内容，用于获取报头。 +- HEAD：返回的响应中没有具体的内容，用于获取报头； - OPTIONS：返回服务器针对特定资源所支持的HTTP请求方法，也可以利用向web服务器发送‘*’ - 的请求来测试服务器的功能性 + 的请求来测试服务器的功能性； -- PUT：向指定资源位置上传其最新内容 +- PUT：向指定资源位置上传其最新内容； -- DELETE：请求服务器删除Request-address所标识的资源 +- DELETE：请求服务器删除Request-address所标识的资源； -- TRACE：回显服务器收到的请求，主要用于测试或诊断 +- TRACE：回显服务器收到的请求，主要用于测试或诊断； - CONNECT：*HTTP1.1*协议中预留给能够将连接改为管道方式的代理服务器。 ## HTTP接口 -### request.get +具体的API接口详解请参考[QuecPython-request-HTTP](https://python.quectel.com/wiki/#/zh-cn/api/QuecPythonThirdlib?id=request-http) -该函数用于发送GET请求。 -- **函数原型** - -request.get(address, data, json, headers) - -- **参数** - -*address*：网址，字符串类型。 - -*data*：（可选参数）附加到请求的正文，json字典类型，默认为None。 - -*json*：（可选参数）json格式用于附加到请求的主体，默认为None。 - -*headers*：（可选参数）请求头，默认为None。 - -- **返回值** - -返回请求对象 - -### request.post - -该函数用于发送POST请求。 - -- **函数原型** - -request.post(address, data, json, headers) - -- **参数** - -*address*：网址，字符串类型。 - -*data*：（可选参数）附加到请求的正文，json字典类型，默认为None。 - -*json*：（可选参数）json格式用于附加到请求的主体，默认为None。 - -*headers*：（可选参数）请求头，默认为None。 - -- **返回值** - -返回请求对象 - -### request.put - -该函数用于发送PUT请求。 - -- **函数原型** - -request.put(address, data, json, headers) - -- **参数** - -*address*：网址，字符串类型。 - -*data*：（可选参数）附加到请求的正文，json字典类型，默认为None。 - -*json*：（可选参数）json格式用于附加到请求的主体，默认为None。 - -*headers*：（可选参数）请求头，默认为None。 - -- **返回值** - -返回请求对象 - -### request.head - -该函数用于发送HEAD请求。 - -- **函数原型** - -request.head(address, data, json, headers) - -- **参数** - -*address*：网址，字符串类型。 - -*data*：（可选参数）附加到请求的正文，json字典类型，默认为None。 - -*json*：（可选参数）json格式用于附加到请求的主体，默认为None。 - -*headers*：（可选参数）请求头，默认为None。 - -- **返回值** - -返回请求对象 - -### request.patch - -该函数用于发送PATCH请求。 - -- **函数原型** - -request.patch(address, data, json, headers) - -- **参数** - -*address*：网址，字符串类型。 - -*data*：（可选参数）附加到请求的正文，json字典类型，默认为None。 - -*json*：（可选参数）json格式用于附加到请求的主体，默认为None。 - -*headers*：（可选参数）请求头，默认为None。 - -- **返回值** - -返回请求对象 - -### request.delete - -该函数用于发送DELETE请求。 - -- **函数原型** - -request.delete(address, data, json, headers) - -- **参数** - -*address*：网址，字符串类型。 - -*data*：（可选参数）附加到请求的正文，json字典类型，默认为None。 - -*json*：（可选参数）json格式用于附加到请求的主体，默认为None。 - -*headers*：（可选参数）请求头，默认为None。 - -- **返回值** - -返回请求对象 - -### reponse类方法说明 +## reponse类方法说明 response =request.get(address) @@ -287,17 +158,12 @@ response =request.get(address) ```python import request - import ujson address = "http://httpbin.org/post" - data = {"key1": "value1", "key2": "value2", "key3": "value3"} - ### POST请求 - response = request.post(address, data=ujson.dumps(data)) - print(response.json()) ``` @@ -313,11 +179,8 @@ print(response.json()) import request address = "http://httpbin.org/get" - ### GET请求 - response = request.get(address) - print(response.json()) ``` @@ -333,11 +196,8 @@ print(response.json()) import request address = "http://httpbin.org/put" - ### PUT请求 - response = request.put(address) - print(response.json()) ``` @@ -351,11 +211,8 @@ print(response.json()) import request address = "http://httpbin.org/patch" - ### PATCH请求 - response = request.patch(address) - print(response.json()) ``` @@ -371,11 +228,8 @@ print(response.json()) import request address = "http://httpbin.org/delete" - ### DELETE请求 - response = request.delete(address) - print(response.json()) ``` @@ -391,11 +245,8 @@ print(response.json()) import request address = "https://myssl.com" - ### HTTPS请求 - response = request.get(address) - for i in response.text: print(i) ``` @@ -412,7 +263,6 @@ for i in response.text: | -------- | --------------------------------- | ---------------- | | API | Application Programming Interface | 应用程序编程接口 | | HTTP | Hyper Text Transfer Protocol | 超文本传输协议 | -| SDK | Software Development Kit | 软件开发工具包 | | TCP | Transmission Control Protocol | 传输控制协议 | | address | Uniform Resource Locator, | 统一资源定位符 | | WWW | World Wide Web | 万维网 | \ No newline at end of file diff --git a/docs/sbs/zh/sbs/media/QuecPytgon_sbs_http_08.png b/docs/sbs/zh/sbs/media/QuecPytgon_sbs_http_08.png new file mode 100644 index 0000000000000000000000000000000000000000..7a786658528f1391aa71de30b21a16b134abd347 Binary files /dev/null and b/docs/sbs/zh/sbs/media/QuecPytgon_sbs_http_08.png differ diff --git a/docs/sbs/zh/sbs/media/de988b13c542b7f454d13cc183693d82.png b/docs/sbs/zh/sbs/media/de988b13c542b7f454d13cc183693d82.png deleted file mode 100644 index 9b3730edcdaad48b0d3e92fe0adc7b256dce8294..0000000000000000000000000000000000000000 Binary files a/docs/sbs/zh/sbs/media/de988b13c542b7f454d13cc183693d82.png and /dev/null differ