org.phoenix.api.action

接口 APIAction

所有已知实现类:

WebAPIAction

public interface APIAction

接口测试

作者:

mengfeiyang

方法概要

限定符和类型	方法和说明
org.apache.http.client.HttpClient	getHttpClientWithProxy(String proxyHost, int proxyPort, String loginName, String loginPass) 返回一个带有代理的HTTPClient，用于设置host
HttpsURLConnection	getHttpsUrlResponse(String httpsUrl, File keyStoreFile, String pass) 请求https的URL，并获得响应内容，响应码,响应头，响应时间等。
HttpsURLConnection	getHttpsUrlResponse(String httpsUrl, String keyStoreFile, String pass) 请求https的URL，并获得响应内容，响应码,响应头，响应时间等。
HttpsURLConnection	getHttpsUrlResponse(String httpsUrl, URI keyStoreFileUri, String pass) 请求https的URL，并获得响应内容，响应码,响应头，响应时间等。
String	getJSONValue(String jsonContent, String jsonPath) 通过指定的jsonpath从json内容中取指定值。
String	getPageSourceByHttpClientWithGet(String url) 使用Apache httpClient获取页面源代码。
String	getPageSourceByHttpClientWithPost(String url) 使用Apache httpClient获取页面源代码。
com.meterware.httpunit.WebResponse	getResponseByGet(String url) get方式请求数据
com.meterware.httpunit.WebResponse	getResponseByGet(String url, HashMap<String,String> parameters, HashMap<String,String> headers) get请求
com.meterware.httpunit.WebResponse	getResponseByGet(String url, int connTimeOut, int readTimeout) 通过get方式load数据
com.meterware.httpunit.WebResponse	getResponseByHost(String url, String postorget, String hostIP, int hostPort) 仅通过设置无需用户名和密码的代理来请求URL
com.meterware.httpunit.WebResponse	getResponseByHost(String url, String postorget, String hostIP, int hostPort, String hostName, String hostPassword) 支持host用户名和密码
com.meterware.httpunit.WebResponse	getResponseByHost(String url, String postorget, com.meterware.httpunit.WebConversation wc) 本方法需要手动指定get或post方式，不区分大小，需要传入一个WebConversation对象
org.apache.http.HttpResponse	getResponseByHttpClient(org.apache.http.client.HttpClient httpClient, String url, String method, HashMap<String,String> headers) 使用代理抓取指定url的内容
org.apache.http.HttpResponse	getResponseByHttpClientWithGet(String url) 使用Apache httpClient获取HttpResponse。
org.apache.http.HttpResponse	getResponseByHttpClientWithPost(String url) 使用Apache httpClient获取HttpResponse。
org.apache.http.HttpResponse	getResponseByHttpClientWithPost(String url, File filePath) 此方法适用于需要post提交文件的需求
org.apache.http.HttpResponse	getResponseByHttpClientWithPost(String url, File filePath, org.apache.http.entity.ContentType contentType) 此方法适用于需要post提交文件的需求
org.apache.http.HttpResponse	getResponseByHttpClientWithPost(String url, HashMap<String,String> headers, File filePath) 此方法适用于需要post提交文件的需求
org.apache.http.HttpResponse	getResponseByHttpClientWithPost(String url, HashMap<String,String> headers, String rawString) 此方法适用于部分字段需要post提交的需求,且可以添加header
org.apache.http.HttpResponse	getResponseByHttpClientWithPost(String url, String rawString) 此方法适用于部分字段需要post提交的需求
com.meterware.httpunit.WebResponse	getResponseByHttpUnit(com.meterware.httpunit.WebConversation wc, String hostIP, int hostPort, String hostUser, String hostPassword, String postorget, String url, int connTimeOut, int readTimeout, HashMap<String,String> parameters, HashMap<String,String> headers) 使用HTTPUnit来抓取url内容
org.jsoup.Connection.Response	getResponseByJsoup(String url, String method, HashMap<String,String> headers) 通过指定的请求方式method，使用Jsoup获得Response对象
org.jsoup.Connection.Response	getResponseByJsoup(String url, String method, HashMap<String,String> datas, HashMap<String,String> headers) 通过指定的请求方式method，使用Jsoup获得Response对象
org.jsoup.Connection.Response	getResponseByJsoup(String url, String method, HashMap<String,String> cookies, HashMap<String,String> datas, HashMap<String,String> headers, boolean isFollowRedirects, String userAgent) 通过指定的请求方式method，使用Jsoup获得Response对象
org.jsoup.Connection.Response	getResponseByJsoupByGet(String url) 通过Jsoup的Get方法获取Response对象，Response对象中包含响应内容，状态码等
org.jsoup.Connection.Response	getResponseByJsoupByPost(String url) 通过Jsoup的Post方法获取Response对象，Response对象中包含响应内容，状态码等
com.meterware.httpunit.WebResponse	getResponseByPost(String url) 通过post方式load数据
com.meterware.httpunit.WebResponse	getResponseByPost(String url, HashMap<String,String> parameters, HashMap<String,String> headers) post请求
com.meterware.httpunit.WebResponse	getResponseByPost(String url, int connTimeOut, int readTimeout) 通过post方式load数据
com.meterware.httpunit.WebResponse	getResponseByPost(String url, String hostIP, int hostPort, HashMap<String,String> params, HashMap<String,String> headers) Post方式 + host请求URL
com.meterware.httpunit.WebConversation	getWebConversation() 获取WebConversation对象，通过这个对象可以设置cookie，host，代理等
org.jsoup.nodes.Document	parseBodyFragment(String bodyHtml) 如果传入的是一个完整的HTML内容，通过此方法只将body部分格式化成Document，而忽略title，header等
org.jsoup.nodes.Document	parseFileToDom(File file) 将文件内容格式化成Document，默认编码是UTF-8
org.jsoup.nodes.Document	parseFileToDom(File file, String charset) 将指定的文件格式化成Document，charset为指定的编码格式
org.jsoup.nodes.Document	parseStringToDom(String html) 将String字符串格式化成Document格式
org.jsoup.nodes.Document	parseStringToDom(URL url, int timeout) 通过get方式请求传入的url对象，并将结果格式化成Document格式

方法详细资料

getHttpsUrlResponse

HttpsURLConnection getHttpsUrlResponse(String httpsUrl,
                                       String keyStoreFile,
                                       String pass)

请求https的URL，并获得响应内容，响应码,响应头，响应时间等。如获取响应内容的方法：
String ls = IOUtils.toString(new InputStreamReader(httpsUrlConn.getInputStream()));或：
List ls = IOUtils.readLines(new InputStreamReader(httpsUrlConn.getInputStream()));
获取响应状态码：httpsUrlConn.getResponseCode();

参数:

httpsUrl - https地址

keyStoreFile - keyStoreFile文件地址

pass - 验证密码

返回:

getHttpsUrlResponse

HttpsURLConnection getHttpsUrlResponse(String httpsUrl,
                                       File keyStoreFile,
                                       String pass)

请求https的URL，并获得响应内容，响应码,响应头，响应时间等。如获取响应内容的方法：
String ls = IOUtils.toString(new InputStreamReader(httpsUrlConn.getInputStream()));或：
List ls = IOUtils.readLines(new InputStreamReader(httpsUrlConn.getInputStream()));
获取响应状态码：httpsUrlConn.getResponseCode();

参数:

httpsUrl - https地址

keyStoreFile - keyStore文件

pass -

返回:

getHttpsUrlResponse

HttpsURLConnection getHttpsUrlResponse(String httpsUrl,
                                       URI keyStoreFileUri,
                                       String pass)

请求https的URL，并获得响应内容，响应码,响应头，响应时间等。如获取响应内容的方法：
String ls = IOUtils.toString(new InputStreamReader(httpsUrlConn.getInputStream()));或：
List ls = IOUtils.readLines(new InputStreamReader(httpsUrlConn.getInputStream()));
获取响应状态码：httpsUrlConn.getResponseCode();

参数:

httpsUrl - https地址

keyStoreFileUri - URI格式的keyStoreFile地址

pass - 验证密码

返回:

getWebConversation

com.meterware.httpunit.WebConversation getWebConversation()

获取WebConversation对象，通过这个对象可以设置cookie，host，代理等

返回:

getResponseByPost

com.meterware.httpunit.WebResponse getResponseByPost(String url,
                                                     String hostIP,
                                                     int hostPort,
                                                     HashMap<String,String> params,
                                                     HashMap<String,String> headers)

Post方式 + host请求URL

参数:

url -

hostIP -

hostPort -

params -

headers -

返回:

getResponseByHost

com.meterware.httpunit.WebResponse getResponseByHost(String url,
                                                     String postorget,
                                                     com.meterware.httpunit.WebConversation wc)

本方法需要手动指定get或post方式，不区分大小，需要传入一个WebConversation对象

参数:

url -

postorget -

wc -

返回:

getResponseByHost

com.meterware.httpunit.WebResponse getResponseByHost(String url,
                                                     String postorget,
                                                     String hostIP,
                                                     int hostPort)

仅通过设置无需用户名和密码的代理来请求URL

参数:

url -

postorget -

hostIP -

hostPort -

返回:

getResponseByHost

com.meterware.httpunit.WebResponse getResponseByHost(String url,
                                                     String postorget,
                                                     String hostIP,
                                                     int hostPort,
                                                     String hostName,
                                                     String hostPassword)

支持host用户名和密码

参数:

url -

postorget -

hostIP -

hostPort -

hostName -

hostPassword -

返回:

getResponseByPost

com.meterware.httpunit.WebResponse getResponseByPost(String url)

通过post方式load数据

参数:

url -

返回:

getResponseByPost

com.meterware.httpunit.WebResponse getResponseByPost(String url,
                                                     int connTimeOut,
                                                     int readTimeout)

通过post方式load数据

参数:

url -

connTimeOut - 最大连接的超时时间

readTimeout - 读取数据的最大超时时间

返回:

getResponseByPost

com.meterware.httpunit.WebResponse getResponseByPost(String url,
                                                     HashMap<String,String> parameters,
                                                     HashMap<String,String> headers)

post请求

参数:

url -

parameters - 接口请求的参数

headers -

返回:

getResponseByGet

com.meterware.httpunit.WebResponse getResponseByGet(String url)

get方式请求数据

参数:

url -

返回:

getResponseByGet

com.meterware.httpunit.WebResponse getResponseByGet(String url,
                                                    int connTimeOut,
                                                    int readTimeout)

通过get方式load数据

参数:

url -

connTimeOut - 最大连接的超时时间

readTimeout - 读取数据的最大超时时间

返回:

getResponseByGet

com.meterware.httpunit.WebResponse getResponseByGet(String url,
                                                    HashMap<String,String> parameters,
                                                    HashMap<String,String> headers)

get请求

参数:

url -

parameters - 接口请求的参数

headers -

返回:

getResponseByHttpUnit

com.meterware.httpunit.WebResponse getResponseByHttpUnit(com.meterware.httpunit.WebConversation wc,
                                                         String hostIP,
                                                         int hostPort,
                                                         String hostUser,
                                                         String hostPassword,
                                                         String postorget,
                                                         String url,
                                                         int connTimeOut,
                                                         int readTimeout,
                                                         HashMap<String,String> parameters,
                                                         HashMap<String,String> headers)

使用HTTPUnit来抓取url内容

参数:

wc -

hostIP - 如果禁用host，则设此值为null

hostPort -

hostUser -

hostPassword -

postorget - post或get方式请求URL，不区分大小写

url -

connTimeOut -

readTimeout -

parameters - URL参数

headers - header设置

返回:

getJSONValue

String getJSONValue(String jsonContent,
                    String jsonPath)

通过指定的jsonpath从json内容中取指定值。

参数:

jsonContent - json的内容

jsonPath - json指定节点的路径

返回:

getHttpClientWithProxy

org.apache.http.client.HttpClient getHttpClientWithProxy(String proxyHost,
                                                         int proxyPort,
                                                         String loginName,
                                                         String loginPass)

返回一个带有代理的HTTPClient，用于设置host

参数:

proxyHost - 代理服务器IP

proxyPort - 代理服务器端口

loginName - 如果需要用户名，则需要提供用户名，否则留空

loginPass - 如果需要密码，则需要提供密码，否则留空

返回:

getResponseByHttpClient

org.apache.http.HttpResponse getResponseByHttpClient(org.apache.http.client.HttpClient httpClient,
                                                     String url,
                                                     String method,
                                                     HashMap<String,String> headers)

使用代理抓取指定url的内容

参数:

httpClient - 带有代理的HTTPClient

url -

method -

headers - urlheader，如果没有则设为null

返回:

getPageSourceByHttpClientWithGet

String getPageSourceByHttpClientWithGet(String url)

使用Apache httpClient获取页面源代码。Get方式

参数:

url -

返回:

getPageSourceByHttpClientWithPost

String getPageSourceByHttpClientWithPost(String url)

使用Apache httpClient获取页面源代码。Post方式

参数:

url -

返回:

getResponseByHttpClientWithGet

org.apache.http.HttpResponse getResponseByHttpClientWithGet(String url)

使用Apache httpClient获取HttpResponse。Get方式

参数:

url -

返回:

getResponseByHttpClientWithPost

org.apache.http.HttpResponse getResponseByHttpClientWithPost(String url)

使用Apache httpClient获取HttpResponse。Post方式

参数:

url -

返回:

getResponseByHttpClientWithPost

org.apache.http.HttpResponse getResponseByHttpClientWithPost(String url,
                                                             String rawString)

此方法适用于部分字段需要post提交的需求

参数:

url -

rawString -

返回:

getResponseByHttpClientWithPost

org.apache.http.HttpResponse getResponseByHttpClientWithPost(String url,
                                                             HashMap<String,String> headers,
                                                             String rawString)

此方法适用于部分字段需要post提交的需求,且可以添加header

参数:

url -

headers -

rawString -

返回:

getResponseByHttpClientWithPost

org.apache.http.HttpResponse getResponseByHttpClientWithPost(String url,
                                                             File filePath)

此方法适用于需要post提交文件的需求

参数:

url - url地址

filePath - 文件路径

返回:

getResponseByHttpClientWithPost

org.apache.http.HttpResponse getResponseByHttpClientWithPost(String url,
                                                             HashMap<String,String> headers,
                                                             File filePath)

此方法适用于需要post提交文件的需求

参数:

url -

headers - 需要添加的header值

filePath -

返回:

getResponseByHttpClientWithPost

org.apache.http.HttpResponse getResponseByHttpClientWithPost(String url,
                                                             File filePath,
                                                             org.apache.http.entity.ContentType contentType)

此方法适用于需要post提交文件的需求

参数:

url -

filePath - 文件路径

contentType - 文件类型

返回:

parseStringToDom

org.jsoup.nodes.Document parseStringToDom(String html)

将String字符串格式化成Document格式

参数:

html -

返回:

parseStringToDom

org.jsoup.nodes.Document parseStringToDom(URL url,
                                          int timeout)

通过get方式请求传入的url对象，并将结果格式化成Document格式

参数:

url -

timeout - 请求的超时时间

返回:

parseFileToDom

org.jsoup.nodes.Document parseFileToDom(File file)

将文件内容格式化成Document，默认编码是UTF-8

参数:

file -

返回:

parseFileToDom

org.jsoup.nodes.Document parseFileToDom(File file,
                                        String charset)

将指定的文件格式化成Document，charset为指定的编码格式

参数:

file -

charset -

返回:

parseBodyFragment

org.jsoup.nodes.Document parseBodyFragment(String bodyHtml)

如果传入的是一个完整的HTML内容，通过此方法只将body部分格式化成Document，而忽略title，header等

参数:

bodyHtml -

返回:

getResponseByJsoupByGet

org.jsoup.Connection.Response getResponseByJsoupByGet(String url)

通过Jsoup的Get方法获取Response对象，Response对象中包含响应内容，状态码等

参数:

url -

返回:

getResponseByJsoupByPost

org.jsoup.Connection.Response getResponseByJsoupByPost(String url)

通过Jsoup的Post方法获取Response对象，Response对象中包含响应内容，状态码等

参数:

url -

返回:

getResponseByJsoup

org.jsoup.Connection.Response getResponseByJsoup(String url,
                                                 String method,
                                                 HashMap<String,String> headers)

通过指定的请求方式method，使用Jsoup获得Response对象

参数:

url - 指定的URL

method - 请求方式，为get或post，不区分大小写

headers - 随请求一起发送的header数据

返回:

getResponseByJsoup

org.jsoup.Connection.Response getResponseByJsoup(String url,
                                                 String method,
                                                 HashMap<String,String> datas,
                                                 HashMap<String,String> headers)

通过指定的请求方式method，使用Jsoup获得Response对象

参数:

url - 指定的URL

method - 请求方式，为get或post，不区分大小写

headers - 随请求一起发送的header数据

datas - 随请求一起发送的datas数据，某些场景下，可通过此方法直接操作参数。如登陆时的用户名和密码

返回:

getResponseByJsoup

org.jsoup.Connection.Response getResponseByJsoup(String url,
                                                 String method,
                                                 HashMap<String,String> cookies,
                                                 HashMap<String,String> datas,
                                                 HashMap<String,String> headers,
                                                 boolean isFollowRedirects,
                                                 String userAgent)

通过指定的请求方式method，使用Jsoup获得Response对象

参数:

url - 指定的URL

method - 请求方式，为get或post，不区分大小写

headers - 随请求一起发送的header数据

datas - 随请求一起发送的datas数据，某些场景下，可通过此方法直接操作参数。如登陆时的用户名和密码

cookies - 随请求一起发送的cookies数据

isFollowRedirects - 如果url自动跳转，则是否follow这个跳转

userAgent - 用户设置的代理

返回: