10个类搞定无任何侵入的开放API服务

1.简介 
   看到了 http://www.iteye.com/topic/1121252 , 
   以前也开发了个简单的开放api系统, 总共用了10个左右的类就可以搞定（使用spring mvc）.现在把代码整理下发出. 

2. 我们最重要的要求是： 简单开发，简单使用 , Service要写的干干净净，让开发API的coder在开发一个API的时候不用学习任何额外的东西, 而是在写一个普通的企业应用里面的Service(or Manager)代码, 下面就是开发一个API的步骤 
  1)定义API接口 

Java代码

1. package ws.service;  
2.   
3.   
4. import ws.annotation.HttpWebService;  
5. import ws.annotation.Path;  
6. import ws.service.impl.Hello;  
7.   
8. @HttpWebService  
9. public interface HelloService {  
10.   
11.   
12.     @Path(value = "/heloWorld", paramNames = "name")  
13.     Hello helloWorld2(String name);  
14.   
15.     @Path(value = "/test")  
16.     void test();  
17.   
18.     @Path(value = "/exception")  
19.     void exception();  
20.   
21. }  

  2.API实现 

Java代码

1. package ws.service.impl;  
2.   
3. import org.apache.commons.logging.Log;  
4. import org.apache.commons.logging.LogFactory;  
5. import ws.service.HelloService;  
6.   
7. public class HelloServiceImpl implements HelloService {  
8.   
9.     private static Log log = LogFactory.getLog(HelloServiceImpl.class);  
10.   
11.     public HelloServiceImpl() {  
12.         log.debug("Hello service init!!!");  
13.     }  
14.   
15.   
16.     @Override  
17.     public Hello helloWorld2(String name) {  
18.         return new Hello(name);  
19.     }  
20.   
21.     @Override  
22.     public void test() {  
23.        log.debug("test");  
24.     }  
25.   
26.     @Override  
27.     public void exception() {  
28.         if(1==1) {  
29.             throw new RuntimeException("error");  
30.         }  
31.     }  
32.   
33. }  

  3.Spring配置 
  

Xml代码

1. <bean id="hello" class="ws.service.impl.HelloServiceImpl"/>  

这样我们就已经定义了3个API了.分别是 /heloWorld ,/test ,/exception  

  下面看调用, 直接使用浏览器, 

 

 

 

完整代码已经放在 

https://github.com/jqq/rest 

上面只是一个简单示例, 保证API的访问安全性代码问题稍后添加, 

是实现方式添加interceptor. 
1.授权校验 
2.hmac校验（对称、非对称） 
3.防重放攻击 
4.超时控制 
5.审计 

实现方式参照 
http://www.thebuzzmedia.com/designing-a-secure-rest-api-without-oauth-authentication/