快速开始

# 👌 新手需知

拥有 Java 开发环境以及相应 IDE
熟悉 Spring Boot
熟悉 Maven

# 📦 安装

# 🍊 Maven

在项目的pom.xml的dependencies中加入以下内容:（必选）

<dependency>
    <groupId>icu.qimuu</groupId>
    <artifactId>qi-api-sdk</artifactId>
    <version>0.0.4</version>
</dependency>

1
2
3
4
5

可以搭配EasyWeb (opens new window)依赖快速启动Web项目 (可选)

<dependency>
    <groupId>icu.qimuu</groupId>
    <artifactId>EasyWeb</artifactId>
    <version>0.0.6</version>
</dependency>

1
2
3
4
5

💥 在新的版本从0.0.6开始，您无需任何配置即可使用Knife4j接口文档，自定义错误码和全局异常处理器，您将感觉不到EasyWeb的存在。

# 🍐 Gradle

implementation group: 'icu.qimuu', name: 'qi-api-sdk', version: '0.0.4'

提示 🔔️

JDK 8 +

# ⚙️ 配置客户端

# 1. 前往Qi-API 接口开放平台 (opens new window) 获取开发者密钥对

# 2. 初始化客户端QiApiClient对象

方法 1 ：主动实例化客户端

String accessKey = "你的 accessKey";
String secretKey = "你的 secretKey";
QiApiClient client = new QiApiClient(accessKey, secretKey);

1
2
3

方法 2 ：通过配置文件注入对象

yml

# Qi-API 配置
qi:
  api:
    client:
      access-key: 你的 accessKey
      secret-key: 你的 secretKey

1
2
3
4
5
6

properties

qi.api.client.access-key=你的 accessKey
qi.api.client.secret-key=你的 secretKey

1
2

# 3. 使用API服务

 @Resource
 private ApiService apiService;

1
2

# 4. 发起请求示例

示例：随机毒鸡汤

示例一：通过配置文件推荐👍

try {
    PoisonousChickenSoupResponse poisonousChickenSoup = apiService.getPoisonousChickenSoup();
    System.out.println("poisonousChickenSoup = " + poisonousChickenSoup);
} catch (ApiException e) {
  log.error(e.getMessage());
}

1
2
3
4
5
6

示例二：主动注入

try {
    QiApiClient qiApiClient = new QiApiClient("你的 accessKey", "你的 secretKey");
    PoisonousChickenSoupResponse poisonousChickenSoup = apiService.getPoisonousChickenSoup(qiApiClient);
    System.out.println("poisonousChickenSoup = " + poisonousChickenSoup);
} catch (ApiException e) {
    log.error(e.getMessage());
}

1
2
3
4
5
6
7

响应：

{
  "text": "不知道你混什么圈，反正我的是混黑眼圈。"
}

1
2
3

搭配EasyWeb (opens new window)示例：推荐👍

@GetMapping("/getPoisonousChickenSoup")
public BaseResponse<PoisonousChickenSoupResponse> getPoisonousChickenSoup() {
    PoisonousChickenSoupResponse poisonousChickenSoup = null;
    try {
        poisonousChickenSoup = apiService.getPoisonousChickenSoup();
    } catch (ApiException e) {
        throw new ApiException(e.getCode(), e.getMessage());
    }
    return ResultUtils.success(poisonousChickenSoup);
}

1
2
3
4
5
6
7
8
9
10

响应示例：

{
  "code": 0,
  "data": {
    "text": "人类三大错觉—手机响了，有人敲门，他（她）喜欢我。"
  },
  "message": "ok"
}

1
2
3
4
5
6
7

更多示例详见：Qi-API-SDK-Demo 示例项目 (opens new window)

# 🐞 提供bug反馈或建议

提交问题反馈请说明正在使用的JDK版本、Qi-API-SDK版本和相关依赖库版本。

帮助我们改善此页面！

上次更新: 2023/09/26, 21:01:40

← 安装返回响应码→