用JeeSite快速搭建网站（3）：提供api接口给移动端

上次在用JeeSite快速搭建网站（2）：单表的增删改查中我们实现单表数据的增删改查了，现在终于来冲击最终目标——提供api接口给移动端。

准备工作：安装swagger

以前的工作流是

1. 服务端写好接口文档
2. 服务端根据文档，写好接口
3. 客户端根据接口文档，在postman中测试接口是否正常
4. 客户端集成。

这种工作流 接口的编写和文档生成是异步发生，文档维护不及时是常有的事情，最后大家往往不会去看文档，而是要求服务端也用postman测试，维护postman脚本了。

但是postman模式下，接口编写和文档生成还是分离的，因此还是不能保证及时更新。基于此，swagger横空出世，它是更好的解决方案，只要在接口代码上加上对应的注解，它会自动提取出api，接口编写和文档生成合二为一。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

swagger安装过程如下：

1. pom.xml文件里面添加组件

        
        
        
            io.springfox
            springfox-swagger2
            2.5.0
        
        
        
            io.springfox
            springfox-swagger-ui
            2.5.0
        
        
        
            io.springfox
            springfox-staticdocs
            2.5.0
                   
        
        
        
            com.cloopen.rest.sdk
            CCPRestSDK
            2.6.3
        

2. spring-mvc.xml里面添加配置

接下来开始写接口啦，针对上次数据库的数据

编写接口

1. 在jeesite.properties中定义api的路径为“/api”

apiPath=/api

2. 在上次生成的代码下，新建Controller

   
   
   

@Api(value = "${apiPath}/upgrade", description = "升级模块")
@Controller
@RequestMapping(value = "${apiPath}/upgrade")
public class ApiUpgradeController {
    
    @Autowired
    private TblApkVersionService tblApkVersionService;
    
    @ApiOperation(value = "获取apk升级信息",  notes = "获取apk升级信息")
    @RequestMapping(value = "getApkUpdateInfo.do",method=RequestMethod.POST)
    public @ResponseBody BaseObjResponse getApkUpdateInfo(@RequestBody BaseRequest req){
        return tblApkVersionService.getApkUpdateInfo();
    }
}

3. 在TblApkVersionService中增加数据库访问接口

@Autowired
TblApkVersionDao tblApkVersionDao;
public BaseObjResponse getApkUpdateInfo() {
  //获取id为1的数据，进行返回
  TblApkVersion tblApkVersion = tblApkVersionDao.get(new TblApkVersion("1"));
  return new BaseObjResponse(tblApkVersion);
}

运行swagger页面，测试接口

1. 访问地址：http://localhost:8080/time/swagger-ui.html
   结果如下：
   

   

2. 输入参数，点击 try it out

   
   
   

   Paste_Image.png

3. 最后看到结果如下：

   
   
   

正好是数据库中的数据：

Yeah，朝着全栈工程师迈进一步啦~~~

Panda
2016-12-10