https://github.com/justlive1/easy-http
easy to contact http rest api
https://github.com/justlive1/easy-http
Last synced: about 1 year ago
JSON representation
easy to contact http rest api
- Host: GitHub
- URL: https://github.com/justlive1/easy-http
- Owner: justlive1
- License: apache-2.0
- Created: 2019-07-03T08:51:22.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T06:09:58.000Z (over 3 years ago)
- Last Synced: 2025-04-10T23:41:52.757Z (over 1 year ago)
- Language: Java
- Size: 26.4 KB
- Stars: 35
- Watchers: 0
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Easy HTTP
README
# easy-http
[](https://maven-badges.herokuapp.com/maven-central/vip.justlive/easy-http/)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
easy to contact http rest api
## 介绍
- 基于Spring mvc`@RequestMapping`、`@GetMapping`、`@PostMapping`、`@RequestParam`、`RequestHeader`、`PathVariable`等注解扩展
- 自动扫描接口实例化并托管至Spring，参考自Mybatis自动扫描Mapper
- 需要声明的接口和Server端保持一致即可完美对接
## 快速开始
### 引入
创建`Maven`项目
```xml
vip.justlive
easy-http
${lastVersion}
```
或`Gradle`
```
compile 'vip.justlive:easy-http:$lastVersion'
```
### 使用方式
```java
// 创建接口
@HttpClient
@RequestMapping("https://api.github.com")
public interface GithubApi {
@RequestMapping(method = RequestMethod.GET)
String root();
@GetMapping("/repos/{owner}/{repo}")
Repository repos(@PathVariable String owner, @PathVariable String repo);
@Data
class Repository {
private Long id;
private String name;
private int forks;
private int watchers;
}
}
// 使用${xx}获取配置
@HttpClient
@RequestMapping("${thirdpart.api.url}")
public interface ThirdpartApi {
@PostMapping("/api/token")
RespVo token(@RequestParam String appKey, @RequestParam String appSecret);
@PostMapping("/api/account")
RespVo account(@RequestHeader String accessToken, @RequestBody Account account);
@Data
@Accessors(chain = true)
class AccessToken {
private String accessToken;
private Long expiresIn;
}
@Data
@Accessors(chain = true)
class Account {
private String name;
private BigDecimal balance;
}
}
// 增加扫描（默认为当前类所处包）
@HttpClientScan("com.xxx")
@Configuration
public class HttpClientAutoConfiguration {
}
// 使用
@Slf4j
@Component
public class Demo {
@Autowired
private GithubApi githubApi;
@Autowired
private ThirdpartApi thirdpartApi;
@PostConstruct
private void init() {
String result = githubApi.root();
log.info("githubApi root {}", result);
Repository repository = githubApi.repos("justlive1", "easy-http");
log.info("githubApi repos {}", repository);
AccessToken token = thirdpartApi.token("key", "secret").getData();
log.info("thirdpartApi token {}", token);
Account account = new Account().setName("aa").setBalance(new BigDecimal("12.3"));
account = thirdpartApi.account(token.getAccessToken(), account).getData();
log.info("thirdpartApi account {}", account);
}
}
```