# openApi

**Repository Path**: ren-qingjun/open-api

## Basic Information

- **Project Name**: openApi
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-04-27
- **Last Updated**: 2025-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 开放平台, 图床

## README

# OpenApi开放平台
基于fleurui项目衍生出的第三方调用接口，目前仅支持图床的部分操作
## 快速开始

##### 1、引入依赖
```xml
<dependency>
    <groupId>top.wrqj</groupId>
    <artifactId>openApi</artifactId>
    <version>0.0.2</version>
</dependency>
```

##### 2、初始化Client对象

```java
String accessKey = "你的accessKey";
String secretKey = "你的secretKey";
ImageClientConfiguration configuration = new ImageClientConfiguration(accessKey,secretKey);
ImageClient imageClient = new ImageClient(configuration);
```

##### 3、方法说明

| 方法名                                           | 参数说明                                                     | 说明                                        |
| ------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------- |
| uploadImage(File file,Long dirId,Double quality) | file: 图片文件；<br />dirId：目录id；<br />quality：压缩比例，null或0则不压缩； | 上传图片接口，仅支持 jpg、jpeg、png格式图片 |
| uploadImage(Image image)                         | fileBase64：图片转成base64格式 <br />suffix：图片后缀，例如 .png<br />imageName：图片名称，可不传 <br />dirId：目录id，默认为根目录<br /> quality：压缩比例，同上 | 重载方法，功能同上                          |
| images()                                         |                                                              | 获取当前用户上传的图片列表                  |
| userInfo()                                       |                                                              | 获取当前用户的信息                          |
| randomImage(Long dirId)                          | dirId：目录id                                                | 根据传入目录id，随机查询一个该目录下的图片  |
| bucketInfo()                                     |                                                              | 获取当前用户绑定的bucket信息                |
| createBucket(String bucketName)                  | bucketName：桶名称                                           | 创建一个桶                                  |
| createDir(Long parentDirId,String dirName)       | parentDirId：要创建目录的父id，根目录为 -1<br />dirName：目录名称 | 创建一个目录                                |
| dirList()                                        |                                                              | 获取当前用户创建的所有目录列表              |

## API文档

### HTTP接入

1、请求地址：https://www.api.wrqj.top/api/v1/openApi

2、请求方式：POST

3、请求信息：

| 请求入参  | 说明                                                        | 示例值                                                    |
| --------- | ----------------------------------------------------------- | --------------------------------------------------------- |
| accessKey | accessKey从平台生成获取，需要以url路径参数的形式拼接在url上 | https://www.api.wrqj.top/api/v1/openApi?accessKey=adasdas |
| secretKey | 同上                                                        |                                                           |

4、请求入参（示例）：

```json
{
    "time":"2024-11-25 20:33:11",
    "interfaceName":"image",
    "method":"uploadImage",
    "extData":{
        "fileBase64":"12312",
        "suffix": ".png",
        "dirId":-1,
        "quality":0
    }
}
```

5、响应参数（示例）：

```json
{
    "code":200,
    "msg":"success",
    "data":"响应数据"
}
```

#### 参数说明：

- time：当前调用接口时间
- interfaceName：调用接口的名称
- method：接口中，需要调用的方法
- extData：其他参数，下面详细说明

extData参数说明

| 参数名称    | 类型     | 说明                                                         |
| ----------- | -------- | ------------------------------------------------------------ |
| fileBase64  | 字符串   | 上传图片必须，图片的base64字符串                             |
| dirId       | 长整型   | 上传图片使用，默认-1                                         |
| suffix      | 字符串   | 上传图片必须，图片的后缀，如 .png                            |
| fileName    | 字符串   | 上传图片使用，可以不传                                       |
| quality     | 双浮点型 | 图片压缩比例，0或null不进行压缩，注意，png格式图片压缩是根据图片像素大小缩放 |
| bucketName  | 字符串   | 创建桶时必传，桶的名称                                       |
| parentDirId | 双浮点型 | 创建目录必传，目录id                                         |
| dirName     | dirName  | 创建目录必须，目录的名称                                     |

#### 接口API说明

| InterfaceName | method       | 说明                                     | extData参数                                                  |
| ------------- | ------------ | ---------------------------------------- | ------------------------------------------------------------ |
| image         | uploadImage  | 上传图片接口                             | {<br />     "fileBase64":"123",<br />     "dirId":-1,<br />     "suffix":".png",<br />     "fileName":"ab",<br />     "quality":0<br />} |
| image         | imageList    | 获取图片列表接口                         |                                                              |
| image         | randomImage  | 随机获取图片接口                         | {<br />     "dirId":-1<br />}                                |
| image         | createDir    | 创建目录接口                             | {<br />      "parentDirId":-1,<br />     "dirName":"目录名称"<br />} |
| image         | dirList      | 获取当前用户所有目录接口                 |                                                              |
| user          | getBucket    | 获取当前用户绑定的桶接口                 |                                                              |
| user          | userInfo     | 获取当前用户信息接口                     |                                                              |
| user          | createBucket | 创建桶接口。注意：一个用户只能创建一个桶 | {<br />     "bucketName":"image"<br />}                      |

#### 响应参数说明