api返回值的标准化的引见（代码示例）【JAVA教程】,api

本篇文章给人人带来的内容是关于api返回值的范例化的引见（代码示例），有肯定的参考价值，有须要的朋侪能够参考一下，愿望对你有所协助。

api返回值的范例化

比方

{"status":200,"message":"操纵胜利","data":"{\"id\":1,\"name\":\"张三\"}"}

封装返回对象

对象被封装在base.util.ResponseUtils范例下，返回值是范例的ResponseEntity对象，返回体
进行了二次封装，主要有status,messsage和data构成，返回要领有ok和okMessage，假如
真是返回音讯，不须要对象，能够挑选运用okMessage，反之运用ok要领。

封装的返回对象：

  @Builder
  @Getter
  @NoArgsConstructor
  @AllArgsConstructor
  static class ResponseBody {

    private int status;
    private String message;
    private Object data;
  }

httpError和我们封装的httpError

关于http error来讲有很多种，基础能够定为code在400到500之间的，像客户端参数题目就是400- bad request,而没有认证就是401-Unauthorized,认证但没有对应的权限就是403-Forbidden,要求的
资本没有发明就是404-Not Found，要求体式格局毛病（要领是post，你提议要求用了get）就是405- Method Not Allowed等。

运用范例http响应状况码

  @GetMapping(GET_HTTP_ERROR)
  ResponseEntity<?> getHttpError() throws IOException {
    return ResponseEntity.badRequest().build();
  }
  @Test
  public void getHttpError() throws Exception {
      mockMvc
          .perform(
              get(LindDemo.GET_HTTP_ERROR)
                  .accept(MediaType.APPLICATION_JSON_UTF8))
          .andExpect(status().is(400));
  
   }

响应的效果

MockHttpServletResponse:
           Status = 400
    Error message = null
          Headers = {}
     Content type = null
             Body = 
    Forwarded URL = null
   Redirected URL = null
          Cookies = []

运用我们封装的status状况码

  @GetMapping(GET_ERROR)
  ResponseEntity<?> getError() throws IOException {
    return ResponseUtils.badRequest("传入的参数不法！");
  }
  
  @Test
    public void getError() throws Exception {
      mockMvc
          .perform(
              get(LindDemo.GET_ERROR)
                  .accept(MediaType.APPLICATION_JSON_UTF8))
          .andExpect(status().isOk());
  
    }

响应的效果

MockHttpServletResponse:
           Status = 200
    Error message = null
          Headers = {Content-Type=[application/json;charset=UTF-8]}
     Content type = application/json;charset=UTF-8
             Body = {"status":400,"message":"传入的参数不法！","data":{}}
    Forwarded URL = null
   Redirected URL = null
          Cookies = []

经由过程上面的响应效果能够看到，我们封装的要求httpcode照样200，只不过把要求毛病400状况码写在了body
对象里，现在这类要领用的比较多，像一些第三方接口用的都是这类体式格局，他们会规定响应的响应范例。