牛刀平台APIRequest SDK使用说明

本文档详细介绍了如何使用牛刀平台提供的apiRequest工具类来调用牛刀平台发布的API。

引入SDK

通过Maven私服引入

如果您使用牛刀云环境的Maven私服，可以通过以下Maven坐标直接引入SDK：

<dependency>
    <groupId>com.justep.utils</groupId>
    <artifactId>api-request</artifactId>
    <!-- 将下面的版本号替换为您所使用的平台版本中的最新版本 -->
    <version>1.0.1</version>
</dependency>

请确保版本号与您所使用的平台版本保持一致，以确保最佳兼容性和功能性。

通过JAR包引入

如果您不通过Maven私服引入，也可以手动从平台安装包中获取api-request.jar文件及其依赖的jar文件。将这些文件复制到您的Java工程的lib目录中使用（具体位置请参考平台安装包的详细说明）。

获取API配置

无环境变量方案

如未使用环境变量，可以在控制台中通过API订阅功能获取API密钥信息。获取后，需将密钥信息反序列化成ApiAuthenticationConfig对象。

ApiAuthenticationConfig apiConfig = JSON.parseObject(
    new String(Base64.decodeBase64("复制的api密钥字符串"), Charset.forName("utf-8")),
    ApiAuthenticationConfig.class);

使用环境变量方案

根据平台的环境变量方案，如果您已经配置了所需调用API的信息，可以直接获取ApiAuthenticationConfig：

ApiAuthenticationConfig apiConfig = com.justep.util.api.ApiRequestUtil.getApiConfig(apiCode);

使用apiConfig及待调用API的详情来计算请求所需的header信息。

// 参数说明：
// apiConfig - 上一步获取到的ApiAuthenticationConfig对象
// requestUri - 要调用的目标API的请求路径（不包含域名，定义中有参数时，需要包含参数）
// requestMethod - 要调用的目标API的HTTP方法（如："get"）

Map<String, String> headers = com.justep.util.api.ApiRequestUtil.getAuthenticationHeader(
    apiConfig, requestUri, requestMethod);

发起API调用

您可使用任何HTTP请求库来发起API调用。调用时，请确保附加上一步计算得到的headers。

注意：虽然apiConfig可以缓存复用，但headers需要在每次发送请求前重新计算。

结语

通过上述步骤，您可以顺利地引入牛刀平台的apiRequest工具类、获取API配置，并计算请求的Header信息来发起对牛刀平台发布的API的调用。这份文档旨在为您提供清晰且易于理解的操作指南，以便您高效地实现API调用。

平台外调用