springboot RESTful风格的API接口开发

版权声明:工作和生活的点点滴滴都应该记录下来! https://blog.csdn.net/u011350541/article/details/80635814

摘要

API接口要求返回的格式是 application/json,我们知道网页返回的格式一般是 text/html,因此,SpringBoot为写接口,提供了两种实现方式:类注解 和 方法注解。

类注解 @RestController

我们只需要在类上写上注解 @RestController,那么此Controller返回格式就都是text/json。如下:

@RestController
@RequestMapping(value = "/article")
public class ArticleController {
}

方法注解 @ResponseBody

我们只需要在某个方法上写上注解 @ResponseBody,那么该方法返回格式是text/json。如下:

   @ResponseBody
   @GetMapping("/v1/random")
   public Object getRandomContent(
           @RequestParam(name = "category", required = false, defaultValue = "z1")
                   String category){
       return articleService.random(category);
   }

值得提醒的是,虽然都是都可以,但更推荐使用类注解,会显得我们的编码风格十分统一,代码更加紧凑,不至于看起来零散。

猜你喜欢

转载自blog.csdn.net/u011350541/article/details/80635814