SpringBoot2.X (七)： Http接口之GET 请求

清疚 2022-05-24 08:18 182阅读 0赞

学习的目的是为了使用，接下来，我们将简单说明一下在SpringBoot2.X中Get 接口请求的应用。

ok， 话不多说，我们直接上代码  
1，首先来一个 测试性质的代码，打印所请求的参数

private final Map<String, Object> params = new HashMap<String, Object>();
        /**
         * 功能描述: 测试restful 协议， 从路径中获取字段
         * @param city_id
         * @param user_id
         * @return
         */
        @GetMapping("/{city_id}/{user_id}")
        public Object findObject(@PathVariable("city_id") String city_id, @PathVariable("user_id") String user_id){
            params.clear();
            params.put("city_id", city_id);
            params.put("user_id", user_id);
            return params;
        }

接口测试，我们这里使用Postman(也可自行使用其他接口测试工具),  
若有不会使用的朋友，可参考笔者所写的[postman 使用][postman]  
客户端下载地址: https://www.getpostman.com/apps

![这里写图片描述][70]

2， 手动设置某些参数的默认值，比如页码，单页数据size等等。。。

/**
         * 功能描述：测试默认值
         * @param page
         * @param size
         * @return
         */
        @GetMapping(value="/list_limit")
        public Object listLimit(@RequestParam(defaultValue="0",name="page") int  page,
                                 @RequestParam(defaultValue = "10", name = "size") int size ){
    
            params.clear();
            params.put("page", page);
            params.put("size", size);
            return params;
        }

在这里，我们不做任何参数的传递，测试接口运行结果  
![这里写图片描述][70 1]

3.我们测试一下通过bean 对象传参

package com.fxbin123.bean;
    
    import lombok.*;
    
    /**
     * Created with IntelliJ IDEA.
     * User: fxbin
     * Date: 2018/5/23
     * Time: 10:01
     * Description:
     */
    @Getter
    @Setter
    @ToString
    public class User {
        private Integer id;
        private String username;
        private Integer age;
    }

/**
         * 功能描述：bean对象传参
         * 注意：1、注意需要指定http头为 content-type为application/json
         * 		2、使用body传输数据
         * @param user
         * @return
         */
        @GetMapping("/save_user")
        public Object saveUser(User user){
            params.clear();
            params.put("user", user);
            return params;
        }

![这里写图片描述][70 2]

4, 我们有时候会获取一下http请求Header 参数值，so, 我们这里写一个 小 demo ，简单说明一下

/**
         * 功能描述：测试获取http头信息
         * @param accessToken
         * @param id
         * @return
         */
        @GetMapping("/get_header")
        public Object getHeader(@RequestHeader("access_token") String accessToken, String id){
            params.clear();
            params.put("access_token", accessToken);
            params.put("id", id);
            return params;
        }

用 postman 测试 结果如下，  
![这里写图片描述][70 3]

这里我们不使用驼峰命名 ，原因有两点：  
1，阅读困难，加下划线之后词距拉大，相对来说阅读起来轻松些。  
2，为了做全文搜索，驼峰你必须忽略大小写。而下划线命名法做全文搜索可以区别大小写。很少有人在用驼峰命名时，编辑器搜索区分大小写。而一旦你习惯了不分大小写的设定，会在区分大小写的场合感到不习惯。  
当然了，这个由个人使用习惯或者团队规范所约束~~~ 哈哈

参考资料：  
restful接口设计规范总结  
https://www.jianshu.com/p/8b769356ee67

[postman]: https://blog.csdn.net/fxbin123/article/details/80428216
[70]: /images/20220524/0d245bac173540d1adccae92d9b5035a.png
[70 1]: /images/20220524/6fc645df07d34fc5859e9641aac8f98a.png
[70 2]: /images/20220524/2d81467e00ea4f6c9caff1cb5f2fa600.png
[70 3]: /images/20220524/86c33181fccf4b06a04e51e98fe63e33.png