文档中心 OpenAPI 生成代码示例

生成代码示例

更新时间:2022-04-11 10:33:56

代码示例

OpenAPI为开发者提供了两种编程语言(Java、Go)的代码示例来简化接口的对接。
点击【示例下载】,可下载接口对应的示例代码。

JAVA

示例代码
示例代码包括以下几个部分

目录 说明
api.models 请求,响应等参数对象实体,请根据接口实际情况更改
-{xxx}Request.java 入参对象
-{xxx}Response.java 出参对象
-Parameters.java URL请求参数
-Paths.java 路径参数
-RequestHeader.java 请求头部
-ResponseHeader.java 响应头部
auth 鉴权逻辑
common 常量包
exception 异常处理
model 通用请求对象
util 通用工具类
Client.java 请求入口类,请根据接口实际情况更改

需要注意的是,下载下来的示例只需要按照接口实际情况调整api.models下的类及Client.java即可。

如果需要整合多个代码示例包,您需要将Client.java重命名,一个API对应一个Client。
1)可在更改名称之后,直接执行覆盖操作。
2)可在更改名称之后手动将 api.model下的{xxx}Request.java {xxx}Response.java以及根目录重命名之后的Client.java复制到另一个包对应位置。

Client.java说明如下:

package com.cnc.wplus;
 
import com.alibaba.fastjson.JSON;
import com.cnc.wplus.api.models.*;
import com.cnc.wplus.auth.*;
import com.cnc.wplus.model.*;
 
public class Client {
 
    public static void main(String[] args) {
        // 构建请求参数
        // JSON.toJSONString(exampleRequest.toMap()) 会将该对象转为JSON字符串
        ExampleRequest exampleRequest = new ExampleRequest();
 
        // 鉴权信息
        AkSkConfig akskConfig = new AkSkConfig();
        akskConfig.setAccessKey("{accessKey}");
        akskConfig.setSecretKey("{secretKey}");
        // EndPoint 您将要访问的域名,填写akskConfig.setEndPoint("open.chinanetcenter.com")
        akskConfig.setEndPoint("{endPoint}");
        // 您将要访问的uri 下载示例代码时已默认填充
        akskConfig.setUri("/example");
        akskConfig.setMethod("POST");
 
        // 请求入口
        // invoke(AkSkConfig, Body)
        String response = AkSkAuth.invoke(akskConfig, JSON.toJSONString(exampleRequest.toMap()));
        System.out.println(response);
    }
}

依赖环境

  • JDK 7版本及以上。
  • Maven 是 JAVA 的依赖管理工具,支持您项目所需的依赖项,并将其安装到项目中。
    请访问 Maven官网 下载对应系统 Maven 安装包进行安装,关于 Maven 详细可参考 Maven官网

GO

示例代码
示例代码包括以下几个部分

目录 说明
api 请求,响应等参数对象实体,请根据接口实际情况更改
- client.go 请求,响应等参数字段信息
Client.go 请求入口

需要注意的是,下载下来的示例只需要按照接口实际情况调整目录下的Client.go与api.client下的client.go即可。

注:如果需要整合多个代码示例包,您需要将根目录下的Client.go与api.client下的client.go重命名,一个API只对应一个Client.go与client.go。
1)可在更改名称之后,直接执行覆盖操作。
2)可在更改名称之后,将刚重命名的两个文件移动至原对应位置。
client.go说明如下:

package main
 
import (
"fmt"
"openApi-authentication/common/auth"
"openApi-authentication/api/client"
)
 
func main() {
 
    // 构造请求参数
    exampleRequest := client.exampleRequest{}
     
    // 鉴权信息
    var config auth.AkskConfig
    config.AccessKey = "{accessKey}"
    config.SecretKey = "{secretKey}"
    // EndPoint 您将要访问的域名,填写为config.EndPoint = "{open.chinanetcenter.com}";
    config.EndPoint = "{endPoint}"
    // 您将要访问的uri 下载示例代码时已默认填充
    config.Uri = "/example"
    config.Method = "POST"
 
    //请求入口
    // invoke(config, Body)
    response := auth.Invoke(config, exampleRequest.String())
    fmt.Printf("response body is %#v\n", response)
}

本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!