HTTP接口对接文档（开发必读）

本文主要介绍如果要在 api 查询组件使用 HTTP 连接器，连接器所连接的接口需要遵循的规范

1 总述

2 入参例子说明

入参例子

{
    "mode": "SEARCH",
    "name": " 张三"
}

3 出参说明

出参示例

{
    "status": "0",
    "message": "success",
    "data": [
        {
            "code": "zhansan",
            "name": "张三"
        },
        {
            "code": " zhangsanfeng",
            "name": " 张三丰"
        }
    ]
}

4 代码demo

    @ApiOperation(value="API查询DEMO")
    @PostMapping("/test/api")
    public RestResp<List<ApiSearchRes>> testApi(@RequestBody @Validated ApiSearchReq req) {
        List<ApiSearchRes> data = baseCommonAppService.apiSearch(req);
        return RestResp.Builder.build(data);
    }


@Data
public class ApiSearchReq {
    /**
     * 模式：SEARCH/TRANSLATE/】
     * 固定参数
     */
    @ApiModelProperty(value = "模式：SEARCH/TRANSLATE")
    private String mode;
    /**
     * 固定参数
     */
    private Integer pageIndex;
    /**
     * 固定参数
     */
    private Integer pageSize;

    private String id;

    private String code;

    private String name;
}

@Data
public class ApiSearchRes {

    /**
     * 固定参数
     */
    private Integer pageIndex;

    /**
     * 固定参数
     */
    private Integer pageSize;

    /**
     * 固定参数
     */
    private Integer total;

    /**
     * 固定参数
     */
    private Integer pages;


    private String parentId;

    private String id;

    private String code;

    private String name;

}



    @Override
    public List<ApiSearchRes> apiSearch(ApiSearchReq req) {
        // 查询模式
        if ("SEARCH".equals(req.getMode())) {
            // 如果是 query 模式，根据配置的 name 字段进行模具查询,name 的值可能为空
            ApiSearchRes apiSearchRes = new ApiSearchRes();
            apiSearchRes.setId("1");
            apiSearchRes.setCode("编码");
            apiSearchRes.setName("名称");
            apiSearchRes.setParentId("-1");
            ApiSearchRes apiSearchRes2 = new ApiSearchRes();
            apiSearchRes.setId("2");
            apiSearchRes.setCode("编码2");
            apiSearchRes.setName("名称2");
            apiSearchRes.setParentId("1");
            return Arrays.asList(apiSearchRes, apiSearchRes2);
        }
        //  翻译模式
        if (StringUtilsEx.isNotEmpty(req.getCode())) {
            // 1、如果是 translate 模式，code 不为空，则为正向翻译，根据 code 进行精准查询，返回为空或者多个则报错
            // 2、针对数据字典过期失效、禁用的情况，业务方需要进行处理
            // 3、需要对 code 进行分割，分隔符为英文逗号，支持批量翻译
            ApiSearchRes apiSearchRes = new ApiSearchRes();
            apiSearchRes.setId("1");
            apiSearchRes.setCode("编码");
            apiSearchRes.setName("名称");
            apiSearchRes.setParentId("-1");
            return Collections.singletonList(apiSearchRes);
        }
        if (StringUtilsEx.isNotEmpty(req.getName())) {
            // 1、 如果是 translate 模式，name 不为空，则为反向翻译，根据 name 进行精准查询
            // 2、针对数据字典过期失效、禁用的情况，业务方需要进行处理
            // 3、需要对 name 进行分割，分隔符为英文逗号，支持批量反向翻译
            ApiSearchRes apiSearchRes = new ApiSearchRes();
            apiSearchRes.setId("1");
            apiSearchRes.setCode("编码");
            apiSearchRes.setName("名称");
            apiSearchRes.setParentId("-1");
            return Collections.singletonList(apiSearchRes);
        }
        return new ArrayList<>();

    }