Forest 使用文档

// 最简单的形式：既没有参数，也没有请求头
@Request(
    url = "http://localhost:8080/hello",
    dataType = "json"
)
MyResp getHello();

@Request(
    url = "http://localhost:8080/hello",
    type = "post",   // 此处类型值为字符串，大小写不敏感
    dataType = "json"
)
MyResp postHello();


@Request(
    url = "http://localhost:8080/hello",
    type = "put",
    dataType = "json"
)
MyResp putHello();


@Request(
    url = "http://localhost:8080/hello",
    type = "head",
    dataType = "json"
)
MyResp headHello();

@Request(
    url = "http://localhost:8080/send",
    dataType = "json"
)
public MyResp send(
    @DataParam("un") String userName,
    @DataParam("pw") String password,
    @DataParam("da") String phoneList,
    @DataParam("sm") String content
);

@Request(
    url = "http://localhost:8080/send?un=${1}&pw=${2}&da=${3}&sm=${4}",
    dataType = "json"
)
MyResp send(
    String userName,
    String password,
    String phoneList,
    String content
);

@Request(
    url = "http://localhost:8080/send",
    headers = "Content-Type: application/x-www-form-urlencoded",
    dataType = "json"
)
MyResp send(
    @DataParam("un") String userName,
    @DataParam("pw") String password,
    @DataParam("da") String phoneList,
    @DataParam("sm") String content
);

@Request(
    url = "http://localhost:8080/send",
    headers = "Content-Type: ${contentType}",
    dataType = "json"
)
MyResp send(
    @DataParam("un") String userName,
    @DataParam("pw") String password,
    @DataParam("da") String phoneList,
    @DataParam("sm") String content,
    @DataVariable("contentType") String contentType
);

@Request(
    url = "http://localhost:8080/send",
    headers = {
            "Content-Type: ${4}",
            "Accept: ${5}"
    },
    dataType = "json"
)
MyResp send(
    @DataParam("un") String userName,
    @DataParam("pw") String password,
    @DataParam("da") String phoneList,
    @DataParam("sm") String content,
    String contentType,
    String accept
);

@Request(
    url = "http://localhost:8080/send?un=${1}&pw=${2}&da=${3}&sm=${4}",
    retryCount = 3,     // 如果失败，最多重试3次
    dataType = "json"
)
MyResp send(String un, String pw, String da, String sm);

@BaseURL("http://localhost:8080")
@BaseRequest(timeout = 3000, headers = "Accept:text/plan", retryCount = 0)
public interface Sender {
    
    @Request(
        url = "/send?un=${0}&pw=${1}&da=${2}&sm=${3}",
        dataType = "json"
    )
    MyResp send(String un, String pw, String da, String sm);
        
    @Request(
        url = "/receive?un=${0}",
        dataType = "json"
    )
    MyResp receive(String un);
}