Ce que cet article vous apporte est une introduction à la standardisation des valeurs de retour de l'API (exemples de code). Il a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer.
Standardisation de la valeur de retour de l'API
Par exemple,
{"status":200,"message":"操作成功","data":"{\"id\":1,\"name\":\"张三\"}"}
L'objet est encapsulé sous base.util.ResponseUtils type et la valeur de retour Il s'agit d'un objet ResponseEntity standard. Le corps de retour
est encapsulé deux fois et se compose principalement du statut, du message et des données. Les méthodes de retour sont ok et okMessage. pas besoin d'un objet, vous pouvez choisir d'utiliser okMessage. Sinon, utilisez la méthode ok.
@Builder @Getter @NoArgsConstructor @AllArgsConstructor static class ResponseBody { private int status; private String message; private Object data; }
demandée est introuvable, ce sera 404-Not Found, la méthode de requête. L'erreur (la méthode est post, vous avez utilisé get pour lancer la requête) est 405- Method Not Allowed, etc.
@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 = []
@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 = []
, cette méthode est actuellement utilisée plus souvent. Certaines interfaces tierces utilisent cette méthode et stipuleront les spécifications de réponse correspondantes.
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!