by-short-server/README.md

<h1 style="text-align: center">百业 - 短链服务v1.0 </h1>
<div style="text-align: center">

[![AUR](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://github.com/elunez/eladmin/blob/master/LICENSE)

</div>

#### 项目简介

为所有的百业业务系统提供短链服务

#### 参考项目地址

|  项目名   | 地址  |
|  ----  | ----  |
| 短链接服务Octopus的实现与源码开放  | https://github.com/zjcscut/octopus |
| 短链接服务  | https://github.com/wyh267/shortService |

#### 模块说明

    short-server-common - 公共模块
    short-server-pojo - dto/bo 用于模块之间的传输实体/领域模型定义
    short-server-service - 短链生成服务

#### 附加功能说明
    
    支持默认定时30天的清除短链(默认开启)
    支持带签名区分的短链形式,例如: 
        request: 
            {
                "baseUrlAddr": "htttps://www.baidu.com/xxdsd/sdsdsds?sadsads=xxxx",
                "variableList": [
                    13111112211,
                    12111112222
                ]
            }
        response:
            {
                "status": 0,
                "data": {
                    "shortChainResult": [
                    "e4ig5miu1n|13111112211",
                    "rtyt8vhx6l|12111112222"
                ]}
            }
    也支持不带签名的短链(这里只支持单条调用)
        request: 
            {
                "baseUrlAddr": "htttps://www.baidu.com/xxdsd/sdsdsds?sadsads=xxxx"
            }
        response:
            {
                "status": 0,
                "data": {
                    "shortChainResult": [
                    "e4ig5miu1n"
                ]}
            }
#### 调用方式及API
    
    批量生成短链API : {{host}}:{{ip}}/send
    短链兑换真实地址API : {{host}}:{{ip}}/返回的短链    

#### 部署方式
    
    by-short-server 目录下 mvn clean install 进行打包
    
    上传到服务器    
    
    运行 ./script 下的 run-short-server.sh 脚本启动