Cai-API-SDK

Cai-API 接口开放平台开发者工具包

目录结构 📝

caiapisdk
    ├─client
    ├─config
    ├─exception
    ├─model
    │  ├─enums
    │  ├─params
    │  ├─request
    │  └─response
    ├─service
    │  └─impi
    └─utils

导航 🧭

• Cai-API 接口开放平台 🔗
• Cai-API-DOC 开发者文档 📖
• Cai-API-SDK-demo ✔️

快速开始 🚀

要开始使用 Cai-API-SDK，您需要按照以下简单进行操作:

1. 引入依赖坐标

<dependency>
   <groupId>com.caiths</groupId>
   <artifactId>cai-api-sdk</artifactId>
   <version>0.0.2</version>
</dependency>   

可以搭配swift-web依赖快速启动Web项目

  <dependency>
     <groupId>com.caiths</groupId>
     <artifactId>swift-web</artifactId>
     <version>0.0.5</version>
  </dependency>

2. 前往Cai-API 接口开放平台 获取开发者密钥对

3. 初始化客户端CaiApiClient对象

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

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

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

  • yml

    # Cai-API 配置
    cai:
      api:
        client:
          access-key: 你的 accessKey
          secret-key: 你的 secretKey
          # 本地网关地址，可修改为自己的网关，用于本地测试，线上网关地址等，不配置默认平台的网关
         # host: http://localhost:8090/api

  • properties

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

4. 使用API服务

 @Resource
 private ApiService apiService;

5. 发起请求示例

示例：随机毒鸡汤

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

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

• 示例二 ：主动注入

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

响应：

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

搭配swift-web示例：推荐👍

@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);
        }

响应示例：

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

• 更多示例详见：Cai-API-SDK-Demo 示例项目
• 更多接口详见：Cai-API-DOC 开发者文档

贡献 🤝

如果您想为 Cai-API 接口开放平台 做出贡献，请随时提交拉取请求。我们始终在寻找方法来改进项目，使其对像您这样的开发者更有用。

联系我们 📩

如果您对 Cai-API 接口开放平台 平台有任何问题或建议，请随时联系我们: 📩邮箱：caiths@icloud.com。

感谢您使用 Cai-API 接口开放平台 ！ 😊