# open api sdk

**Repository Path**: JCLearning/open-api-sdk

## Basic Information

- **Project Name**: open api sdk
- **Description**: 开放平台 sdk。

实现一个开箱即用的 sdk。
- **Primary Language**: Java
- **License**: AGPL-3.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-22
- **Last Updated**: 2024-12-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# simpel code
增加飞书群机器人 api 对接。

先来思考一个问题？我们在使用一些工具或者 sdk 的时候，为什么导入一个依赖，在配置文件里面加几行业务属性配置就直接可以开箱即用了？

我举个例子：阿里云的短信 sdk。

阿里云开发文档：https://help.aliyun.com/zh/sdk/product-overview/v3-request-structure-and-signature?spm=a2c4g.11186623.0.0.136474b8Rqiz0o

假设短信接入示例：
* step1：导入相关依赖
```xml
# step1: 导入相关依赖
<!-- aliyun sms -->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>tea-openapi</artifactId>
    <version>0.2.2</version>
</dependency>

<!-- aliyun sms -->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>dysmsapi20170525</artifactId>
    <version>2.0.18</version>
</dependency>
```
* step2：配置业务参数，阿里云颁发的 key 和 secret 等
* step3：开箱即用
```java
Config config = new Config()
        .setAccessKeyId(key)
        .setAccessKeySecret(secret);
config.endpoint = "https:xxxxx 阿里云短信 api url";

RuntimeOptions runtimeOptions = new RuntimeOptions();
# 利用 阿里云 提供的 client 调用短信接口 
client.sendSmsWithOptions(requestParams, runtimeOptions)
```

后续规划：
* 做一个内部的 api sdk 工具，发布到 maven 私库，类似阿里云的 sdk 一样开箱给内部用。
* 在第一个的基础上做一个 api 服务
举个例子，阿里云短信 api 限流，调用次数统计，防刷机制等，设计这么一套系统。
  
* 拆解一下开源工具，看一下他们是如何设计的
极大可能是选取 Hutool 的某个子模块。