README.md · kingboyrang/restapi_demo - Gitee.com

5月24日 | Gitee Talk 模力方舟 AI 应用沙龙合肥站，多个 AI+ 项目实践分享，跨行业 AI 场景落地，报名现已开启~

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

文件

该仓库未声明开源许可证文件（LICENSE），使用请关注具体项目描述及其代码上游依赖。

克隆/下载

README.md 2.69 KB

# restapi_demo

#### 介绍
java接口开发统一模板

#### 软件架构

springboot rest api使用版本控制+请求加解密+统一异常处理

#### 安装说明

如idea未安装lombok插件，则需要搜索安装

#### 使用说明

1.使用版本控制@ApiVersion(1)
  可在方法上加上@ApiVersion(1)注解，控制接口版本号，1表示v1版本，2表示v2版本

举例如下:

```
 //版本更新
    @ResponseBody
    @ApiVersion(1)  //接口版本
    @RequestMapping(value = "/update", method = RequestMethod.POST)
    public Result versionUpdate(){

Map<String, Object> resultParams = new HashMap<String, Object>();
        resultParams.put("pv", "ios");
        resultParams.put("versionName", "v1.0.1");
        resultParams.put("versionCode", "20");
        resultParams.put("downUrl", "http://www.baidu.com");
        resultParams.put("versionDesc", "有新版本更新");
        resultParams.put("type", "1");
        resultParams.put("gap", "0");
        return Result.ok(resultParams);
    }
```

2.使用@DecryptRequest注解
  方法请求需要解密,不需要解密，则设置为@DecryptRequest(false)

举例如下:

```
@ResponseBody
    @ApiVersion(1)  //接口版本
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    @DecryptRequest  //请求解密
    @EncryptResponse //响应加密
    public Result userLogin(@RequestBody String body){

log.info("解密后的body={}",body);

Map<String, Object> resultParams = new HashMap<String, Object>();
        resultParams.put("name", "kingboyrang");
        resultParams.put("id", "1");
        resultParams.put("phone", "13621541236");
        return Result.ok(resultParams);
    }
```

3.使用@EncryptResponse注解
  方法响应返回需要加密,不需要加密，则设置为@EncryptResponse(false)

举例如下:

```
@ResponseBody
    @ApiVersion(1)  //接口版本
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    @DecryptRequest  //请求解密
    @EncryptResponse //响应加密
    public Result userLogin(@RequestBody String body){

log.info("解密后的body={}",body);

Map<String, Object> resultParams = new HashMap<String, Object>();
        resultParams.put("name", "kingboyrang");
        resultParams.put("id", "1");
        resultParams.put("phone", "13621541236");
        return Result.ok(resultParams);
    }
```

4.ExceptionController为统一异常处理类
5.程序使用的是aes加解密方式
6.扩展其它加解密方式

(1)继承Crypto接口，实现其它加解密类
(2)修改RRCryptoConfig类中的rrCrypto方法，返回其它加解密类

一键复制编辑原始数据按行查看历史

提交于 2021-10-17 14:13 +08:00 . update README.md.

# restapi_demo

#### 介绍
java接口开发统一模板

#### 软件架构

springboot rest api使用版本控制+请求加解密+统一异常处理

#### 安装说明

如idea未安装lombok插件，则需要搜索安装


#### 使用说明

1.使用版本控制@ApiVersion(1)
  可在方法上加上@ApiVersion(1)注解，控制接口版本号，1表示v1版本，2表示v2版本

举例如下:


```
 //版本更新
    @ResponseBody
    @ApiVersion(1)  //接口版本
    @RequestMapping(value = "/update", method = RequestMethod.POST)
    public Result versionUpdate(){

        Map<String, Object> resultParams = new HashMap<String, Object>();
        resultParams.put("pv", "ios");
        resultParams.put("versionName", "v1.0.1");
        resultParams.put("versionCode", "20");
        resultParams.put("downUrl", "http://www.baidu.com");
        resultParams.put("versionDesc", "有新版本更新");
        resultParams.put("type", "1");
        resultParams.put("gap", "0");
        return Result.ok(resultParams);
    }
```


2.使用@DecryptRequest注解
  方法请求需要解密,不需要解密，则设置为@DecryptRequest(false)

举例如下:


```
@ResponseBody
    @ApiVersion(1)  //接口版本
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    @DecryptRequest  //请求解密
    @EncryptResponse //响应加密
    public Result userLogin(@RequestBody String body){

        log.info("解密后的body={}",body);

        Map<String, Object> resultParams = new HashMap<String, Object>();
        resultParams.put("name", "kingboyrang");
        resultParams.put("id", "1");
        resultParams.put("phone", "13621541236");
        return Result.ok(resultParams);
    }
```

3.使用@EncryptResponse注解
  方法响应返回需要加密,不需要加密，则设置为@EncryptResponse(false)

举例如下:


```
@ResponseBody
    @ApiVersion(1)  //接口版本
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    @DecryptRequest  //请求解密
    @EncryptResponse //响应加密
    public Result userLogin(@RequestBody String body){

        log.info("解密后的body={}",body);

        Map<String, Object> resultParams = new HashMap<String, Object>();
        resultParams.put("name", "kingboyrang");
        resultParams.put("id", "1");
        resultParams.put("phone", "13621541236");
        return Result.ok(resultParams);
    }
```

4.ExceptionController为统一异常处理类
5.程序使用的是aes加解密方式
6.扩展其它加解密方式

(1)继承Crypto接口，实现其它加解密类
(2)修改RRCryptoConfig类中的rrCrypto方法，返回其它加解密类

Loading...

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

Java

1

https://gitee.com/rang/restapi_demo.git

git@gitee.com:rang/restapi_demo.git

rang

restapi_demo

restapi_demo

master