API-Hub-SDK

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

系统架构

目录结构 📝

├───client    -->ApiClient的创建
│       ApiClient.java
│
├───config    -->配置类
│       ApiClientConfig.java
│
├───exception    -->异常
│       ApiException.java
│       ErrorCode.java
│       ErrorResponse.java
│
├───model
│   ├───enums    -->请求方法枚举类
│   │       RequestMethodEnum.java
│   │
│   ├───params    -->请求参数封装
│   │       HoroscopeParams.java
│   │       IpInfoParams.java
│   │       LocationParam.java
│   │       LoveParams.java
│   │       NameParams.java
│   │       PoetParam.java
│   │       PoisonousChickenSoupParams.java
│   │       RandomWallpaperParams.java
│   │       WeatherParams.java
│   │
│   ├───request    -->请求
│   │       BaseRequest.java
│   │       CurrencyRequest.java
│   │       HoroscopeRequest.java
│   │       IpInfoRequest.java
│   │       LoveRequest.java
│   │       NameRequest.java
│   │       PoisonousChickenSoupRequest.java
│   │       RandomWallpaperRequest.java
│   │       WeatherRequest.java
│   │
│   └───response    -->响应
│           LoveResponse.java
│           NameResponse.java
│           PoisonousChickenSoupResponse.java
│           RandomWallpaperResponse.java
│           ResultResponse.java
│
├───service    -->服务
│   │   ApiService.java
│   │   BaseService.java
│   │
│   └───impl    -->实现
│           ApiServiceImpl.java
│
└───utils    -->签名认证工具类
        SignUtils.java

导航 🧭

• API-Hub 接口开放平台 🔗
• API-Hub-DOC 开发者文档 📖

快速开始 🚀

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

1. 引入依赖坐标

<dependency>
    <artifactId>api-sdk</artifactId>
    <name>api-sdk</name>
    <version>0.0.1</version>
</dependency>   

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

3. 初始化客户端ApiClient对象

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

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

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

  • yml

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

  • properties

    api.client.access-key=你的 accessKey
    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 {
    ApiClient qiApiClient = new ApiClient("你的 accessKey", "你的 secretKey");
    PoisonousChickenSoupResponse poisonousChickenSoup = apiService.getPoisonousChickenSoup(qiApiClient);
    System.out.println("poisonousChickenSoup = " + poisonousChickenSoup);
} catch (ApiException e) {
    log.error(e.getMessage());
}

响应：

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

• 更多接口详见：API-Hub-DOC 开发者文档

贡献 🤝

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

联系我们 📩

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

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