# memory-api-JavaSDK

**Repository Path**: deng-2022/memory-api-java-sdk

## Basic Information

- **Project Name**: memory-api-JavaSDK
- **Description**: 只需一行代码，即可调用丰富的接口服务
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-06
- **Last Updated**: 2024-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# memory-api-JavaSDK 

## 🍜 什么是客户端 SDK？

客户端 SDK（Software Development Kit）：

客户端 SDK 通常指的是一套为开发者提供的工具集，它包含了库、API、示例代码以及文档等，使得开发者能够更方便、快捷地开发出符合特定平台或服务的客户端应用。这些 SDK 往往是为了方便开发者接入某个平台或服务而设计的，其中可能包含了认证、数据交互、用户界面组件等多种功能。

## 🦪 本项目为什么要开发 SDK？

其他开发者在集成本项目所开发的客户端 SDK 后，仅需通过`简洁的配置步骤`，便可在其本地项目代码中无缝接入 MemoryAPI 忆汇廊所提供的`多样化接口服务`，实现高效、安全的数据交互与业务处理。

## 🥩 如何使用客户端 SDK？

### 注册登录平台

- 在 API 开放平台进行注册登录，可以获取到开发者密钥 ak、sk

![image-20240224163806434](https://gitee.com/deng-2022/pictures/raw/master/images/image-20240224163806434.png)

### 客户端 SDK 下载

- 下载 SDK 代码到本地，在本地使用 mvn install 命令打包 SDK：
<!-- - (待日后发布至 Maven 中央仓库后，即可直接从 Maven 中央仓库引入 pom 依赖) -->

![image-20240226200537043](https://gitee.com/deng-2022/pictures/raw/master/images/image-20240226200537043.png)

- 导入依赖：在本地项目中引入 SDK 依赖即可使用

```xml
<dependency>
    <groupId>com.memory</groupId>
    <artifactId>memory-client-spring-boot-starter</artifactId>
    <version>0.0.1</version>
</dependency>
```

### 项目配置

- 在项目的 application.yml 配置文件中填写客户端配置，比如 ak、sk 等

```yaml
memory:
  client:
    access-key: memory
    secret-key: 12345678
```

### 接口调用

- 这里演示如何调用`随机获取壁纸`接口服务：

- 项目启动时，会自动创建一个客户端调用对象，可以直接在项目中注入该对象并使用。直接调用接口：

```java
import com.memory.client.model.Picture;
import com.memory.client.service.MemoryClientService;

@Resource
private MemoryClientService memoryClientService;
```

```java
Picture picture = new Picture("girl");
String girlImgListStr = memoryClientService.getPictureListByType(picture);
System.out.println(girlImgListStr);
```

- 执行代码，结果如下：

![image-20240225142637078](https://gitee.com/deng-2022/pictures/raw/master/images/image-20240225142637078.png)