创建标签
| 接口名 | POST: /login-register/open-api/tags | |||
| 入参:(body传值) | application/json | |||
| 是否必传 | 默认值 | 描述 | 备注 | |
| name | 是 | - | 标签中文名称 | 长度5个字符以内 |
| enName | 否 | - | 标签英文名称 | 标签英文名称 |
| tagCode | 是 | - | 标签编码(业务标识) | 在外部系统中的唯一标识 |
| sort | 否 | - | 排序值,Interger类型 | 越小越靠前 |
| description | 否 | - | 标签描述 | 标签描述 |
| 入参:(Header传值) | ||||
| Authorization | 是 | - | 传递AccessToken | 格式:Bearer {AccessToken} |
| 入参示例:(application/json) | ||||
|
{
"name": "Api",
"enName": "Api",
"tagCode": "TAG_OpenApi_001",
"sort": 1,
"description": "OpenApi测试标签"
}
|
||||
| 回参示例:(application/json) | ||||
|
{
"code": 0,
"msg": null,
"data": {
"id": "2090750569436114946",
"name": "Api",
"enName": "Api",
"tagCode": "TAG_OpenApi_001"
},
"ok": true
}
|
||||
package com.hoteam.sview.demo;
import cn.hutool.core.util.StrUtil;
import cn.hutool.http.ContentType;
import cn.hutool.http.Header;
import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpStatus;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import lombok.extern.slf4j.Slf4j;
import java.util.HashMap;
import java.util.Map;
/**
* 创建标签Demo
* 接口:POST /login-register/open-api/tags
* <p>
* 成功判定:HTTP 200 且 code=0,返回 data.id
* 失败:HTTP 401 / 非 2xx / code!=0 / 网络异常,返回 null
*/
@Slf4j
public class CreateTagHutoolDemo {
/** 接口地址(按实际环境替换 host) */
private static final String CREATE_TAG_URL =
"http://your-host/login-register/open-api/tags";
/** AccessToken(按实际值替换,可通过 /auth/oauth2/token 接口预先获取) */
private static final String ACCESS_TOKEN = "your_access_token";
public static void main(String[] args) {
// 示例:创建标签
String tagId = createTag(
"Api", // name 标签中文名称(必填,5个字符以内)
"Api", // enName 标签英文名称(非必填)
"TAG_OpenApi_001", // tagCode 标签编码(业务标识)(必填)
1, // sort 排序值(非必填,Integer类型,越小越靠前)
"OpenApi测试标签" // description 标签描述(非必填)
);
if (tagId == null) {
log.warn("创建标签失败");
return;
}
log.info("创建标签成功,tagId={}", tagId);
}
/**
* 创建标签
*
* @param name 标签中文名称(必填,长度5个字符以内)
* @param enName 标签英文名称(非必填)
* @param tagCode 标签编码(业务标识)(必填,在外部系统中的唯一标识)
* @param sort 排序值(非必填,Integer类型,越小越靠前)
* @param description 标签描述(非必填)
* @return 成功返回 data.id;失败返回 null
*/
public static String createTag(String name,
String enName,
String tagCode,
Integer sort,
String description) {
// 1. 参数校验
if (StrUtil.isBlank(name) || StrUtil.isBlank(tagCode)) {
log.warn("创建标签必填参数缺失:name={}, tagCode={}", name, tagCode);
return null;
}
if (name.length() > 5) {
log.warn("标签中文名称长度不能超过5个字符:name={}", name);
return null;
}
// 2. 组装请求体
Map<String, Object> requestMap = new HashMap<>();
requestMap.put("name", name);
requestMap.put("enName", enName);
requestMap.put("tagCode", tagCode);
requestMap.put("sort", sort);
requestMap.put("description", description);
String requestBody = JSONUtil.toJsonStr(requestMap);
log.info("创建标签请求报文:{}", requestBody);
// 3. 发起请求
try (HttpResponse response = HttpRequest.post(CREATE_TAG_URL)
// 公共 Header
.header("tenant-id", "1")
.header("deviceId", "web")
.header("deviceModel", "web")
.header("deviceType", "4")
.header("lang", "zh-CN")
// 认证 + Content-Type
.header(Header.AUTHORIZATION, "Bearer " + ACCESS_TOKEN)
.header(Header.CONTENT_TYPE, ContentType.JSON.getValue())
.body(requestBody)
.timeout(10_000)
.execute()) {
int status = response.getStatus();
String body = response.body();
log.info("创建标签响应:status={}, body={}", status, body);
// 3.1 401 认证失败
if (status == HttpStatus.HTTP_UNAUTHORIZED) {
log.warn("创建标签认证失败(401),accessToken 可能失效,body={}", body);
return null;
}
// 3.2 非 2xx 或响应体为空
if (!response.isOk() || StrUtil.isBlank(body)) {
log.warn("创建标签请求失败:status={}, body={}", status, body);
return null;
}
// 4. 业务字段判定:仅以 code=0 为成功
JSONObject json = JSONUtil.parseObj(body);
Integer code = json.getInt("code");
if (code == null || code != 0) {
log.warn("创建标签业务失败:code={}, msg={}", code, json.getStr("msg"));
return null;
}
// 5. 成功,返回 data.id
JSONObject data = json.getJSONObject("data");
return data == null ? null : data.getStr("id");
} catch (Exception e) {
log.error("调用创建标签接口异常", e);
return null;
}
}
}