http

Added in: v0.2.0

http模块提供了一个基础的HTTP远程调用接口。

Examples:

GET

const http = require('http');

const res = http.request('http://www.example.com').get();

if(res.success) {
    const value = res.json();
    //...
}else {
    //...
}

POST

const http = require('http');
const params = {name: '...'};

const res = http.request('http://www.example.com').json(params).post();

//...

http.client

Added in: v0.2.0

• {HttpClient}

http.client属性返回底层的HttpClient对象。

http.request(url[, path])

Added in: v0.2.0

• url {string} 要调用的http(s) url
• path {string} 相对于url的相对路径
• Returns: {HttpRequest} 返回一个请求对象

基于指定的地址（或拼接上相对路径）创建一个新的HttpRequest对象返回（尚未真正执行请求）。

Class: HttpClient

Added in: v0.2.0

Java Class: leap.lang.http.client.HttpClient

Class: HttpRequest

Added in: v0.2.0

Java Class: leap.lang.http.client.HttpRequest

request.query(name, value)

Added in: v0.2.0

• name {string} 参数名
• value {string} 参数值
• Returns {HttpRequest} 返回request对象自身

给请求添加一个查询参数。

request.form(name, value)

Added in: v0.2.0

• name {string} 参数名
• value {string} 参数值
• Returns {HttpRequest} 返回request对象自身

给请求添加一个Form参数。

request.header(name, value)

Added in: v0.2.0

• name {string} 参数名
• value {string} 参数值
• Returns {HttpRequest} 返回request对象自身

给请求添加一个Header参数。

request.contentType(contentType)

Added in: v0.2.0

• contentType {string} Content Type
• Returns {HttpRequest} 返回request对象自身

设置请求的Content-Type。

request.method(method)

Added in: v0.2.0

• method {string} HTTP Method
• Returns {HttpRequest} 返回request对象自身

设置请求方法[GET,POST,PUT,PATCH,DELETE]。

request.body(body)

Added in: v0.2.0

• body {string} Body Content
• Returns {HttpRequest} 返回request对象自身

以字符串方式设置请求体。

request.json(value)

Added in: v0.2.0

• value {any} Body Content
• Returns {HttpRequest} 返回request对象自身

把value进行JSON.stringify(value)后设置为请求体，同时设置Content-Type为applicaiton/json。

Example:

    const params = {name: '...'};

    const res = http.request('http://example.com').json(params).post();

    //...

request.send([method])

Added in: v0.2.0

• method {string} HTTP Method
• Returns {HttpResponse} 返回响应对象

发送请求并返回响应对象。

request.get()

Added in: v0.2.0

等同于：request.method('GET').send()

request.post()

Added in: v0.2.0

等同于：request.method('POST').send()

request.post()

Added in: v0.2.0

等同于：request.method('POST').send()

request.put()

Added in: v0.2.0

等同于：request.method('PUT').send()

request.patch()

Added in: v0.2.0

等同于：request.method('PATCH').send()

request.delete()

Added in: v0.2.0

等同于：request.method('PATCH').send()

Class: HttpResponse

Added in: v0.2.0

Java Class: leap.lang.http.client.HttpResponse

response.status

• {integer}

获取HTTP响应状态码

response.success

• {boolean}

等同于status >= 200 && status < 300。

response.body()

• Returns {string}

以字符串返回响应体。

response.json()

• Returns {any}

对响应体进行JSON.parse(body())并返回。

response.header(name)

• name {string} Header name
• Returns {string} Header value

获取响应Header的值。

response.headers(name)

• name {string} Header name
• Returns {string[]} Header values.

以数组访问获取响应Header的值（存在多个值的情况）。