接口种类
webservice接口、HTTP接口（SSL认证）、RPC接口
什么是接口
接口泛指实体把自己提供给外界的一种抽象化物（可以为另一实体），用以由内部操作分离出外部沟通方法，使其能被内部修改而不影响外界其他实体与其交互的方式。
http接口类型
HTTP1.0定义了三种请求方法： GET, POST 和 HEAD方法。
HTTP1.1新增了五种请求方法：OPTIONS, PUT, DELETE, TRACE 和 CONNECT 方法
| 方法 | 描述 |
|---|---|
| GET | 请求指定 页面信息，并返回实体主题 |
| HEAD | 向服务器索要与GET请求相一致的响应，只不过响应体不会被返回，这一方法可以在不必传输整个响应内容的情况下，就可以获取包含在响应消息头中的元信息。 |
| POST | 向指定资源提交数据进行处理请求（例如提交表单或者上传文件） |
| PUT | 向指定资源位置上传其最新内容， 从客户端向服务器传送的数据取代指定的文档的内容。 |
| DELETE | 请求服务器删除Request-URI所标识的资源，也就是删除所指定的页面 |
| CONNECT | HTTP/1.1协议中预留给能够将连接改为管道方式的代理服务器 |
| OPTIONS | 返回服务器针对特定资源所支持的http请求方法，允许客户端查看服务器的性能 |
| TRACE | 回显服务器收到的请求，主要用于测试或诊断 |
应用实例
发布接口
SpringBoot发布接口
@PostMapping
客户端只能用 POST方式请求，适用于提交数据。
@GetMapping
客户端只能用 GET 方式请求，适用于查询数据
@DeleteMapping
客户端只能用 DELETE方式请求，使用于删除数据
@PutMapping
客户端只能用 PUT方式请求，使用于修改数据
请求接口
post请求
public static boolean doPost(String url, xxxx, xxxxx) throws ClientProtocolException, IOException {
LOGGER.info("{}" + url);
CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader("Content-Type", "application/json");
JSONObject json = new JSONObject();
json.put("key1", xxx);
json.put("key2", xxx);
StringEntity httpEntity = new StringEntity(json.toJSONString(), StandardCharsets.UTF_8);
httpPost.setEntity((HttpEntity)httpEntity);
CloseableHttpResponse closeableHttpResponse = httpClient.execute((HttpUriRequest)httpPost);
int statusCode = closeableHttpResponse.getStatusLine().getStatusCode();
if (statusCode != 200) {
LOGGER.error("{}" + statusCode);
return false;
}
LOGGER.info(");
return true;
}
get请求
public static Boolean doGet(String url, xxxxxxx) throws ClientProtocolException, IOException {
LOGGER.info("{}" + url);
CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader("Content-Type", "application/json");
JSONObject json = new JSONObject();
json.put("key1", xxx);
json.put("key2", xxx);
json.put("key3", xxx);
StringEntity httpEntity = new StringEntity(json.toJSONString(), StandardCharsets.UTF_8);
httpPost.setEntity((HttpEntity)httpEntity);
CloseableHttpResponse closeableHttpResponse = httpClient.execute((HttpUriRequest)httpPost);
int statusCode = closeableHttpResponse.getStatusLine().getStatusCode();
if (statusCode != 200) {
LOGGER.error("{}" + statusCode);
return Boolean.valueOf(false);
}
LOGGER.info("");
return Boolean.valueOf(true);
}
JS接口请求
$.ajax({
url:"http://www.microsoft.com", //请求的url地址
dataType:"json", //返回格式为json
async:true,//请求是否异步，默认为异步，这也是ajax重要特性
data:{
"id":"value"}, //参数值
type:"POST", //请求方式 get、post
beforeSend:function(){
//请求前的处理
},
success:function(req){
//请求成功时处理
},
complete:function(){
//请求完成的处理
},
error:function(){
//请求出错处理
}
});
调试接口
可以用过工具postMan、页面请求
常见异常问题解决
413异常
客户端请求体过大，造成请求容量异常
1、需要设置nginx中的客户端属性大小：【client_max_body_size 10m】
2、F5转发就需要设置
3、可以后台分流发送数据