Java SDK 接入教程：10 分钟调通第一个接口

用 Java 调用 YesApi 接口的完整教程：从安装、签名算法、发起请求到错误处理，附可运行示例代码。

最后更新：2026-07-20作者：YesApi Pro 团队 · 广州果创网络科技 SDK接入

核心结论：Java 接入 YesApi 三步走：①按「参数值排序拼接 + app_secret 后 MD5 大写」生成 sign；②POST 到 HOST/?s=服务名，带 s/app_key/sign；③判断返回 ret==200 再取 data。下方有 Java 完整示例代码。

⭐ 编辑推荐

想要自己的 API 平台？

YesApi Pro 私有部署后，用同样的 SDK 方式接入你自建的接口——源码交付、当天上线。

查看详情 →

一、准备与安装

Java 侧用标准库 + 任一 HTTP 客户端（OkHttp / HttpClient）即可，签名用 JDK 自带的 MessageDigest。以下用 OkHttp 示例。

<!-- Maven 依赖：OkHttp -->
<dependency>
  <groupId>com.squareup.okhttp3</groupId>
  <artifactId>okhttp</artifactId>
  <version>4.12.0</version>
</dependency>

二、签名算法（核心）

YesApi 接口用签名（sign）防篡改，算法固定：把参数按 key 升序排序 → 拼接所有参数值（不含 key）→ 末尾追加 app_secret → MD5 → 转大写。各语言实现一致，务必与服务端保持相同规则。

// 签名：TreeMap 按 key 升序 → 拼接所有 value → 追加 app_secret → md5 → 大写
import java.security.MessageDigest;
import java.util.TreeMap;

public static String yesapiSign(TreeMap<String, String> params, String appSecret) throws Exception {
    StringBuilder sb = new StringBuilder();
    for (String v : params.values()) sb.append(v);
    sb.append(appSecret);
    byte[] digest = MessageDigest.getInstance("MD5")
            .digest(sb.toString().getBytes("UTF-8"));
    StringBuilder hex = new StringBuilder();
    for (byte b : digest) hex.append(String.format("%02X", b));
    return hex.toString();
}

三、发起第一个请求

请求方式为 POST，地址为 HOST/?s=服务名，参数用 form 表单编码，需带上 s、app_key 与计算好的 sign。下面是 Java 的完整可运行示例：

import okhttp3.*;
import java.util.TreeMap;

String host = "http://your-domain.yesapi.cn/";
String appKey = "YOUR_APP_KEY";
String appSecret = "YOUR_APP_SECRET";
String service = "App.Table.FreeQuery";

TreeMap<String, String> params = new TreeMap<>();
params.put("model_name", "news");
params.put("page", "1");
params.put("perpage", "10");
params.put("s", service);
params.put("app_key", appKey);
params.put("sign", yesapiSign(params, appSecret));

FormBody.Builder form = new FormBody.Builder();
params.forEach(form::add);

Request request = new Request.Builder()
        .url(host.replaceAll("/$", "") + "/?s=" + service)
        .post(form.build())
        .build();

OkHttpClient client = new OkHttpClient();
try (Response resp = client.newCall(request).execute()) {
    System.out.println(resp.body().string());
}

四、返回结构与错误处理

YesApi 统一返回 JSON：ret 为状态码（200 成功），data 为业务数据，msg 为错误信息。务必判断 ret 再取数据：

// 建议用 Jackson/Gson 解析，判断 ret 字段
// {"ret":200,"data":{...},"msg":""}
JsonNode root = new ObjectMapper().readTree(json);
if (root.path("ret").asInt() == 200) {
    JsonNode data = root.path("data");   // 业务数据
} else {
    String msg = root.path("msg").asText("请求失败");
    log.error("YesApi error: {}", msg);
}