接口文档描述修改

yangys

2025-07-09 785f3d5be63e723a947a2b35dc0ca89297073d7f

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/**
 * BladeX Commercial License Agreement
 * Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
 * <p>
 * Use of this software is governed by the Commercial License Agreement
 * obtained after purchasing a license from BladeX.
 * <p>
 * 1. This software is for development use only under a valid license
 * from BladeX.
 * <p>
 * 2. Redistribution of this software's source code to any third party
 * without a commercial license is strictly prohibited.
 * <p>
 * 3. Licensees may copyright their own code but cannot use segments
 * from this software for such purposes. Copyright of this software
 * remains with BladeX.
 * <p>
 * Using this software signifies agreement to this License, and the software
 * must not be used for illegal purposes.
 * <p>
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
 * not liable for any claims arising from secondary or illegal development.
 * <p>
 * Author: Chill Zhuang (bladejava@qq.com)
 */
package org.springblade.system.feign;
 
 
import org.springblade.core.launch.constant.AppConstant;
import org.springblade.core.tool.api.R;
import org.springblade.system.pojo.entity.Dict;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
 
import java.util.List;
 
/**
 * Feign接口类
 *
 * @author Chill
 */
@FeignClient(
    value = AppConstant.APPLICATION_SYSTEM_NAME,
    fallback = IDictClientFallback.class
)
public interface IDictClient {
 
    String API_PREFIX = "/feign/client/dict";
    String GET_BY_ID = API_PREFIX + "/get-by-id";
    String GET_VALUE = API_PREFIX + "/get-value";
    String GET_LIST = API_PREFIX + "/get-list";
 
    /**
     * 获取字典实体
     *
     * @param id 主键
     * @return
     */
    @GetMapping(GET_BY_ID)
    R<Dict> getById(@RequestParam("id") Long id);
 
    /**
     * 获取字典表对应值
     *
     * @param code    字典编号
     * @param dictKey 字典序号
     * @return
     */
    @GetMapping(GET_VALUE)
    R<String> getValue(@RequestParam("code") String code, @RequestParam("dictKey") String dictKey);
 
    /**
     * 获取字典表
     *
     * @param code 字典编号
     * @return
     */
    @GetMapping(GET_LIST)
    R<List<Dict>> getList(@RequestParam("code") String code);
 
}