# mingdao-sdk

**Repository Path**: xd502djj/mingdao-sdk

## Basic Information

- **Project Name**: mingdao-sdk
- **Description**: 明道云访问SDK，自己使用的时候没有，暂时自己做部分吧
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-06
- **Last Updated**: 2025-10-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# 明道云 SDK

这是一个用于访问明道云 API 的 Java SDK，提供了一系列客户端工具来简化与明道云平台的集成。

## 功能特性

- 提供 `WorkSheetClient` 类用于操作明道云的工作表数据。
- 支持添加、查询、编辑和删除行数据。
- 支持过滤查询、获取行关联信息、分享链接、讨论和操作日志等功能。
- 提供多种实体类来封装请求和响应数据。
- 包含工具类用于 HTTP 请求处理、JSON 转换和属性读取等操作。
- 若使用 Spring Boot，还提供自动配置支持。

## 安装

将以下依赖添加到你的 `pom.xml` 文件中：

```xml
<dependency>
    <groupId>cn.bj.xd</groupId>
    <artifactId>mingdao-sdk-core</artifactId>
    <version>版本号</version>
</dependency>
```

如果你使用 Spring Boot，还可以添加以下依赖以获得自动配置支持：

```xml
<dependency>
    <groupId>cn.bj.jak</groupId>
    <artifactId>mingdao-sdk-spring-starter</artifactId>
    <version>版本号</version>
</dependency>
```

## 使用示例

### 初始化客户端

```java
WorkSheetClient client = new WorkSheetClient("API地址", "API密钥", "签名");
```

### 添加一行数据

```java
RowInfo row = new RowInfo();
// 设置行数据...
MdyResult<?> result = client.addRow(row);
```

### 查询行数据

```java
MdyRequest request = new MdyRequest();
// 设置查询参数...
MdyResult<MdyData<YourDataType>> result = client.getFilterRows(request, new TypeReference<>() {});
```

### 编辑行数据

```java
RowInfo row = new RowInfo();
// 设置更新的数据...
MdyResult<?> result = client.editRow(row);
```

### 删除行数据

```java
MdyResult<?> result = client.deleteRow("worksheetId", "rowId");
```

## 配置（Spring Boot）

在 `application.yml` 或 `application.properties` 中添加如下配置：

```yaml
mingdao:
  enabled: true
  application:
    your-app-key:
      address: "API地址"
      apiKey: "API密钥"
      sign: "签名"
```

## 许可证

本项目使用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。