/shorturl

短网址服务

Primary LanguageCSSApache License 2.0Apache-2.0

shorturl

A Short Url Service Written By Golang

特性

  • 使用 Mysql 存储原始数据
  • 采用进制算法，保证短码不重复，安全可靠
  • 使用lru cache 缓存热点数据，性能可靠
  • 支持点击数统计，统计数据异步落盘
  • 支持平滑重启，重启服务不影响使用用户，命令: kill -1 pid
  • QPS可达上万，简单易用

介绍

主要基于golang的gin框架，日志采用的beego的组件，数据库采用的gorm,目前主要实现了3个接口，包括网址生成、短网址的查询，1个批量生成接口，还有一个页面用于短网址的解析跳转功能！

使用方法

本项目使用go module管理依赖，使用 go mod download 下载依赖，然后使用go build main.go编译！

打开.env文件配置好 Mysql 连接信息,目前还没用到 Redis，感兴趣的可以自己加一层Redis缓存，性能更好！

接口文档

1.短网址生成

URL
/v1/create
Content-Type
application/x-www-form-urlencoded
HTTP请求方式
POST
请求参数
参数 必选 类型 说明
url true string 用来生成短网址的url
响应结果
{
    "code": 200,
    "data": {
        "url": "http://127.0.0.1:8080/mCv"
    },
    "msg": "ok"
}

2.短网址查询

URL
/v1/query
Content-Type
application/x-www-form-urlencoded
HTTP请求方式
POST
请求参数
参数 必选 类型 说明
code true string 生成的短码
响应结果
{
    "code": 200,
    "data": {
        "url": "http://www.google.com"
    },
    "msg": "ok"
}

3.批量生成短网址

URL
/v1/multicreate
Content-Type
application/json
HTTP请求方式
POST
请求参数
参数 必选 类型 说明
urls true array 多个需生成短网址的url,最多50个
响应结果
{
    "code": 200,
    "data": {
        "urls": {
            "http://www.abc.com": "XrUnl",
            "http://www.baidu.com": "ArCnl"
        }
    },
    "msg": "ok"
}