我们将允许第三方的客户端去检查RESTAPI返回的结果。这些结果可能是JSON或XML的结果。
我们想要去操作这样的访问地址:/api/search/mixed;keywords=springFramework。这个跟我们之前访问过的地址是一样的,不过我们要它返回的是api。每一个URI找到的命名空间都是二进制的结果。
让我们创建一个新有类SearchApiController在search.api的包下。
package masterSpringMVC5.api;
import masterSpringMVC5.search.LightTweet;
import masterSpringMVC5.search.SearchService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.social.twitter.api.Tweet;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* 请求API,请求结果以json的形式返回给客户端
* Created by OwenWilliam on 2016/5/21.
*/
@RestController
@RequestMapping("/api/search")
public class SearchApiController
{
private SearchService searchService;
@Autowired
public SearchApiController(SearchService searchService)
{
this.searchService = searchService;
}
/**
* It tells Spring to serialize the return type to the appropriate format, which is JSON by default.
* @param searchType
* @param keywords
* @return
*/
@RequestMapping(value = "/{searchType}", method = RequestMethod.GET)
public List<LightTweet> search(@PathVariable String searchType, @MatrixVariable List<String> keywords)
{
return searchService.search(searchType, keywords);
}
}
这跟我们之前的控制层极其相似,下面有三个不一样的地方:
1) 控制层的类的注解是@RequestMapping。这个是我们地址访问的基础,而将前缀映射定义在控制器中。
2) 我们查找的方法,再也没有返回视图结果了。
3) 我们控制器注解为@RestControllser替换@Controller.
@RestController 是控制器的简单定义,如果我们注解了@ResponseBody,那么将会返回每一个请求的结果。它将会告诉Spring去实例化返回的结果,格式化结果,以JSON格式是默认的。
当REST API工作时,你可以通过不同的请求方法去等到响应,如GET或POST。而GET和POST的请求方式是不同方式的。
如果你在地址栏里输入:http://localhost:8080/api/search/mixed;keywords=springFramework,你将会看到下面的结果。
源码下载:git@github.com:owenwilliam/masterSpringMVC.git