# ff-api-sdk

**Repository Path**: wxplatform_admin/ff-api-sdk

## Basic Information

- **Project Name**: ff-api-sdk
- **Description**: Ff API 接口开放平台 SDK
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-09-10
- **Last Updated**: 2024-09-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">Ff-API-SDK</h1>
<p align="center"><strong>Ff-API 接口开放平台开发者工具包</strong></p>

### 目录结构 📝

```text

│sdk
    ├── client
    ├── config
    ├── exception
    ├── model
      ├── enums
      ├── params
      ├── request
      ├── response
      └── vo
    ├── service
        └── impl
    └── utils
```

### 导航 🧭

- **[Ff-API 接口开放平台 🔗](http://www.ffapi.top/)**
- **[Ff-API-DOC 开发者文档 📖](http://doc.ffapi.top/)**

###  快速开始 🚀

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

#### 1. 引入依赖坐标

```xml
<dependency>
   <groupId>top.ffapi</groupId>
   <artifactId>ff-api-sdk</artifactId>
   <version>0.0.1</version>
</dependency>   
```

#### 2. 前往[Ff-API 接口开放平台](http://www.ffapi.top/) 获取开发者密钥对

#### 3. 初始化客户端FfApiClient对象

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

  ```java
  String accessKey = "你的 accessKey";
  String secretKey = "你的 secretKey";
  String id = "你的 appId";
  FApiClient client = new FApiClient(accessKey, secretKey, id);
  ```

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

  - yml

    ```yml
    # Ff-API 配置
    fapi:
      client:
        access-key: 你的 accessKey
        secret-key: 你的 secretKey
        id: 你的 appId
    ```
    
  - properties
  
    ```properties
    fapi.client.access-key=你的 accessKey
    fapi.client.secret-key=你的 secretKey
    fapi.client.id=你的 appId
    ```

#### 4. 使用API服务

   ```java
    @Resource
    private ApiService apiService;
   ```

#### 5. 发起请求示例

示例：随机毒鸡汤

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

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

- 示例二 ：主动注入
```java
try {
    FApiClient client = new FApiClient("你的 accessKey", "你的 secretKey", "你的 appId");
    PoisonousChickenSoupResponse poisonousChickenSoup = apiService.getPoisonousChickenSoup(client);
    System.out.println("poisonousChickenSoup = " + poisonousChickenSoup);
} catch (ApiException e) {
    log.error(e.getMessage());
}
```

响应：

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

响应示例：

```json
{
  "code": 0,
  "data": {
    "text": "人类三大错觉—手机响了，有人敲门，他（她）喜欢我。"
  },
  "message": "ok"
}
```
- **更多接口详见：[Ff-API-DOC 开发者文档](http://doc.ffapi.top/)**

### 贡献 🤝

如果您想为 **[Ff-API 接口开放平台](http://www.ffapi.top/)**  做出贡献，请随时提交拉取请求。我们始终在寻找方法来改进项目，使其对像您这样的开发者更有用。

### 联系我们 📩

如果您对 **[Ff-API 接口开放平台](http://www.ffapi.top/)**  平台有任何问题或建议，请随时联系我们:📩邮箱：1320716446@qq.com。

感谢您使用 **[Ff-API 接口开放平台](http://www.ffapi.top/)**  ！ 😊