写在前面的话
网络程序正朝着移动设备的方向发展,前后端分离、APP,最好的交互交互方式莫过于通过API接口实现。既然要进行数据交互,那么这接口就得有讲究了:既要实用,又要优雅好看!
那么,如何写一套漂亮的API接口呢?
本次我们先了解一下Spring对API接口开发的支持,然后我们采用Spring Boot搭建项目,借用Swagger2列出API接口,便于查阅。
返回格式
API接口要求返回的格式是 application/json,我们知道网页返回的格式一般是 text/html,因此,Spring Boot为写接口,提供了两种实现方式:类注解 和 方法注解。
类注解 @RestController
我们只需要在类上写上注解 @RestController,那么此Controller返回格式就都是text/json。如下图
方法注解 @ResponseBody
我们只需要在某个方法上写上注解 @ResponseBody,那么该方法返回格式是text/json。如下图
值得提醒的是,虽然都是都可以,但我更推荐使用类注解,会显得我们的编码风格十分统一,代码更加紧凑,不至于看起来零散。
我们来看下 @RestController 的源码
请求方式