Skip to content

tenxcloud/gateway-sdks

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
gateway-sdk
gateway-sdk
 
 
sdk-api
sdk-api
 
 
HELP.md
HELP.md
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 
sdk.iml
sdk.iml
 
 

Repository files navigation

HTTP SDK README

HTTP SDK工具类，用来向服务端发送HTTP请求。如果提供认证参数，它能够在内部将请求消息进行签名处理，然后向API网关发送进行验证和调用，目前支持的认证类型有basic-auth,jwt,oauth2,hmac-auth,支持的调用方式method有get,post,delete,patch,put,options,head。

请求API网关Restful服务的访问地址

网关地址访问格式： http://{网关ip}:80/{api网关访问路径}

  • {ip} API网关的ip地址
  • 默认的访问端口为 "80"，可以不填写
  • 请求的context-path可以要根据API网关的访问路径填写

工具包的下载地址

HTTP Client SDK 使用方式

使用编程方式调用

import com.apigateway.sdk.HttpCaller;
import com.apigateway.sdk.dto.AuthParam;
import com.apigateway.sdk.dto.HttpReturn;
import com.apigateway.sdk.exception.HttpCallerException;
 ...

(1) 直接调用方式 POST 参数为json 认证为basic-auth，其中认证参数根据应用市场中的<已购资产>中的资产信息获取，如下的authType为<访问控制方式>如：basic-auth，如下的username和password在<访问凭证>的详情中获取。

 		String url="http://{ip}:80/{path}";
 		//设置header参数
        Map<String, String> headerParam = new HashMap<>();
        headerParam.put("header1","value1");
        //设置json的请求参数
        JSONObject requestJ = new JSONObject();
        requestJ.put("key1", "value1");
        requestJ.put("key2", "value2");
        //设置认证参数，比如basic-auth类型
        AuthParam authParam = new AuthParam();
        //认证类型
        authParam.setAuthType("basic-auth");
        //basic-auth 用户名
        authParam.setUsername("ccc");
        //basic-auth 秘钥
        authParam.setPassword("2sHGo~j&c");
        //设置请求content-type 也可以不填写 例如String contentType = ""
        String contentType = "application/json;charset=utf-8";
        try {
            HttpReturn httpReturn = HttpCaller.doPost(url,headerParam,contentType, new 				ContentBody(requestJ.toJSONString()),authParam);
            log.info(JSONObject.toJSONString(httpReturn));
        } catch (HttpCallerException e) {
            e.printStackTrace();
            // error process
        }

(2) 直接调用方式 POST 参数为Map 认证为jwt，其中认证参数根据应用市场中的<已购资产>中的资产信息获取，如下的authType为<访问控制方式>如：jwt，如下的key、secret和algorithm(如：HS256)在<访问凭证>的详情中获取。

 		String url="http://{ip}:80/{path}";
 		//设置header参数
        Map<String, String> headerParam = new HashMap<>();
        headerParam.put("header1","value1");
        //设置Map的请求参数
        Map<String, String> paramsMap = new HashMap<>();
        paramsMap.put("key1", "value1");
        paramsMap.put("key2", "value2");
        //设置认证参数，比如jwt类型
        AuthParam authParam = new AuthParam();
        //认证类型
        authParam.setAuthType("jwt");
        //jwt 参数key
        authParam.setKey("key");
        //jwt 秘钥或者是私钥
        authParam.setSecretOrPrivateKey("secret");
        //加密算法，包括：HS256，HS384，HS512，RS256，ES256
        authParam.setAlgorithm("HS256");
        //设置请求content-type 也可以不填写 例如String contentType = ""
        String contentType = "application/x-www-form-urlencoded;charset=utf-8";
        try {
            HttpReturn httpReturn = HttpCaller.doPost(url,
            headerParam,contentType,paramsMap,authParam);
            log.info(JSONObject.toJSONString(httpReturn));
        } catch (HttpCallerException e) {
            e.printStackTrace();
            // error process
        }

(3) 直接调用方式 POST 参数为xml 认证为hmac-auth，其中认证参数根据应用市场中的<已购资产>中的资产信息获取，如下的authType为<访问控制方式>如：hmac-auth，如下的username、secret和algorithm(如：hmac-sha1)在<访问凭证>的详情中获取。

 		String url="http://{ip}:80/{path}";
 		//设置header参数
        Map<String, String> headerParam = new HashMap<>();
        headerParam.put("header1","value1");
        //设置xml的请求参数
        Document document = DocumentHelper.createDocument();
        Element root = document.addElement("root1");
        Element key1 = root.addElement("key1");
        Element key2 = root.addElement("key2");
        key1.addText("value1");
        key2.addText("value2");
        String output = document.asXML();
        //设置认证参数，比如hmac-auth类型
        AuthParam authParam = new AuthParam();
        //认证类型
        authParam.setAuthType("hmac-auth");
        //hmac-auth 用户名
        authParam.setHmacUserName("username");
        //hmac-auth 秘钥
        authParam.setHmacSecret("secret");
        //加密算法，hmac-sha1，hmac-sha256，hmac-sha384，hmac-sha512，默认值是：hmac-sha1
        authParam.setHmacAlgorithm("hmac-sha1");
        //设置请求content-type 也可以不填写 例如String contentType = ""
        String contentType="application/xml;charset=utf-8";
        try {
            HttpReturn httpReturn = HttpCaller.doPost(url,
            headerParam,contentType,new ContentBody(output),authParam);
            log.info(JSONObject.toJSONString(httpReturn));
        } catch (HttpCallerException e) {
            e.printStackTrace();
            // error process
        }

(4) 直接调用方式GET 认证为oauth2，其中认证参数根据应用市场中的<已购资产>中的资产信息获取，如下的authType为<访问控制方式>如：oauth2，如下的clientId和clientSecret在<访问凭证>的详情中获取，scope参数在没有特殊说明时为空串即可。

 		String url="http://{ip}:80/{path}";
 		//设置header参数
        Map<String, String> headerParam = new HashMap<>();
        headerParam.put("header1","value1");
        //设置Map的请求参数 参数会拼接在url上，参数也可以在url上拼接完成，这里空Map即可
        Map<String, String> paramsMap = new HashMap<>();
        paramsMap.put("key1", "value1");
        paramsMap.put("key2", "value2");
        //设置认证参数，比如oauth2类型
        AuthParam authParam = new AuthParam();
        //认证类型
        authParam.setAuthType("oauth2");
        //oauth2 clientId
        authParam.setClientId("clientId");
        //oauth2 clientSecret
        authParam.setClientSecret("clientSecret");
        //oauth2 scope 根据情况可以不填
        authParam.setScope("scope");
        //设置请求content-type 也可以不填写 例如String contentType = ""
        String contentType="";
        try {
            HttpReturn httpReturn = HttpCaller.doGet(url,
            headerParam,contentType,paramsMap,authParam);
            log.info(JSONObject.toJSONString(httpReturn));
        } catch (HttpCallerException e) {
            e.printStackTrace();
            // error process
        }

(5) 直接调用方式Put/Patch 注意参数类型可以参考Post中的详细demo

//Put 参数Map
HttpReturn httpReturn = HttpCaller.doPut(url,
            headerParam,contentType,paramsMap,authParam);
//Put 参数json
HttpReturn httpReturn = HttpCaller.doPut(url,headerParam,contentType, new 	                         ContentBody(requestJ.toJSONString()),authParam);
//Put 参数xml
HttpReturn httpReturn = HttpCaller.doPut(url,headerParam,contentType, new                             ContentBody(output),authParam);
//Patch 参数Map
HttpReturn httpReturn = HttpCaller.doPatch(url,
            headerParam,contentType,paramsMap,authParam);
//Patch 参数json            
HttpReturn httpReturn = HttpCaller.doPatch(url,headerParam,contentType, new 		                              ContentBody(requestJ.toJSONString()),authParam);
//Patch 参数xml 
HttpReturn httpReturn = HttpCaller.doPatch(url,headerParam,contentType, new 	                     ContentBody(output),authParam);

(6) 直接调用方式Head/Options 注意参数类型可以参考Get中的详细demo

 //head
 HttpReturn httpReturn = HttpCaller.doHead(url,
            headerParam,contentType,paramsMap,authParam);
 //options
 HttpReturn httpReturn = HttpCaller.doOptions(url,
            headerParam,contentType,paramsMap,authParam);

(7) 直接调用方式Delete 认证为oauth2 ，其中认证参数根据应用市场中的<已购资产>中的资产信息获取，如下的authType为<访问控制方式>如：oauth2，如下的clientId和clientSecret在<访问凭证>的详情中获取，scope参数在没有特殊说明时为空串即可。

 		String url="http://{ip}:80/{path}";
 		//设置header参数
        Map<String, String> headerParam = new HashMap<>();
        headerParam.put("header1","value1");
        //设置Map的请求参数
        Map<String, String> paramsMap = new HashMap<>();
        //设置认证参数，比如oauth2类型
        AuthParam authParam = new AuthParam();
        //认证类型
        authParam.setAuthType("oauth2");
        //oauth2 clientId
        authParam.setClientId("clientId");
        //oauth2 clientSecret
        authParam.setClientSecret("clientSecret");
        //oauth2 scope 根据情况可以不填
        authParam.setScope("scope");
        //设置请求content-type 也可以不填写 例如String contentType = ""
        String contentType="";
        try {
            HttpReturn httpReturn = HttpCaller.doDelete(url,
            headerParam,contentType,paramsMap,authParam);
            log.info(JSONObject.toJSONString(httpReturn));
        } catch (HttpCallerException e) {
            e.printStackTrace();
            // error process
        }

(8) 直接调用方式Get 下载文件

 		String url="http://{ip}:80/{path}";
 		//设置header参数
        Map<String, String> headerParam = new HashMap<>();
        headerParam.put("header1","value1");
        //设置Map的请求参数 参数会拼接在url上，参数也可以在url上拼接完成，这里空Map即可
        Map<String, String> paramsMap = new HashMap<>();
        paramsMap.put("key1", "value1");
        paramsMap.put("key2", "value2");
        //设置认证参数，比如oauth2类型
        AuthParam authParam = new AuthParam();
        //认证类型
        authParam.setAuthType("oauth2");
        //oauth2 clientId
        authParam.setClientId("clientId");
        //oauth2 clientSecret
        authParam.setClientSecret("clientSecret");
        //oauth2 scope 根据情况可以不填
        authParam.setScope("scope");
        //设置请求content-type 也可以不填写 例如String contentType = ""
        String contentType="";
        response.reset(); 
        try {
            HttpReturn httpReturn = HttpCaller.doGet(url,
            headerParam,contentType,paramsMap,authParam);
            httpReturn.getHeaderMap().get("fileName");
            log.info(JSONObject.toJSONString(httpReturn));
            response.setHeader("Content-Disposition", "attachment; 						             filename=\""+httpReturn.getHeaderMap().get("fileName")+"\";charset=utf-8");
            //取文件流
            byte[] bytes = httpReturn.getResponseBytes();
            OutputStream out = response.getOutputStream();
            InputStream br = new ByteArrayInputStream(bytes);
            byte[] buf = new byte[1024];
            int len = 0;
            while ((len = br.read(buf)) > 0)
                out.write(buf, 0, len);
            br.close();
            out.close();
        } catch (HttpCallerException e) {
            e.printStackTrace();
            // error process
        }

(9) 直接调用方式Post 上传文件

 		String url="http://{ip}:80/{path}";
 		//设置header参数
        Map<String, String> headerParam = new HashMap<>();
        headerParam.put("header1","value1");
        //设置Map的请求参数
        Map<String, String> paramsMap = new HashMap<>();
        //设置认证参数，比如oauth2类型
        AuthParam authParam = new AuthParam();
        //认证类型
        authParam.setAuthType("oauth2");
        //oauth2 clientId
        authParam.setClientId("clientId");
        //oauth2 clientSecret
        authParam.setClientSecret("clientSecret");
        //oauth2 scope 根据情况可以不填
        authParam.setScope("scope");
        //设置请求content-type 也可以不填写 例如String contentType = ""
        String contentType="";
        //上传的文件
        MultipartHttpServletRequest params = ((MultipartHttpServletRequest) request);
        paramsMap.put("key1", params.getParameter("key1"));
        paramsMap.put("key2", params.getParameter("key2"));
        List<MultipartFile> files = ((MultipartHttpServletRequest) 					             request).getFiles("fileKey");
        MultipartFile file = null;
        try {
              for (int i = 0; i < files.size(); ++i) {
                file = files.get(i);
                if (!file.isEmpty()) {
                    InputStream in = file.getInputStream();
                    HttpReturn httpReturn = HttpCaller.doPost(url, headerParam, "",
                            paramsMap, file.getName(), in, ContentEncoding.none, null);
                    log.info(httpReturn.toString());
                    return JSONObject.toJSONString(httpReturn);
                } else {
                    log.info("You failed to upload " + i + " because the file was                                      empty.");
                }
            }
        } catch (HttpCallerException e) {
            e.printStackTrace();
            // error process
        } catch (Exception e) {
            e.printStackTrace();
            // error process
        }

(10) 使用Builder的方式构造调用参数，然后进行调用

 import com.apigateway.sdk.HttpParameters;
 import com.apigateway.sdk.HttpCaller;
 import com.apigateway.sdk.HttpCallerException;
  
  HttpParameters.Builder builder = HttpParameters.newBuilder();
      
  builder.requestURL("http://ip:80/{path}") // 设置请求的URL
      .method("POST") // 设置调用方式
      .contentType("application/x-www-form-urlencoded;charset=utf-8"); //设置请求content-type
      
   // 设置请求参数
   builder.putParamsMap("key1", "value1");
   builder.putParamsMap("key2", "{\"a\":value1}"); // json format value
   builder.putParamsMap("key3", "value1","value2","value3");//设置数组参数
      
   //设置请求调用方式
   builder.method("POST");
      
   //设置透传的HTTP Headers
   builder.putHeaderParamsMap("header1", "value1");
   builder.putHeaderParamsMap("header2", "value2");
   //设置认证参数 例如jwt
   AuthParam authParam = new AuthParam();
   authParam.setAuthType("jwt");
   authParam.setKey("value1");
   authParam.setSecretOrPrivateKey("value2");
   authParam.setAlgorithm("HS256");
   builder.authParam(authParam);
   //进行调用 返回结果
   String result = null;
   try {
      	HttpReturn res = HttpCaller.invokeReturn(builder.build()); //然后在res里获取相关的信息
      	res.getResponseStr();//获取响应的文本串。
      	res.responseBytes;//获取响应二进制数据，比如图片
   } catch (HttpCallerException e) {
      	// error process
   }

About

SDKs to invoke API of TAMP

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

3 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages