开放实验室 · API 文档

一、项目说明

工具类的接口服务,域名是 https://mazey.cn

二、接口说明

查询请求者的IP、位置、天气

接口描述:

查询请求者的IP、位置、天气。

请求路径: /server/user/info

请求方式: GET

请求示例:

curl --location --request GET 'https://mazey.cn/server/user/info'

返回参数:

返回参数 参数类型 参数说明 是否必有
ret Number 执行结果 0-成功 其他失败
info String 成功/失败代码
message String 成功/错误信息
data Object 数据
data.ip String IP
data.location Object 位置
data.weather Object 天气

返回示例:

成功

{
    "ret": 0,
    "info": "ok",
    "message": "成功",
    "data": {
        "ip": "183.195.178.142",
        "location": {
            "operator": "移动",
            "continent": "亚洲",
            "country": "中国",
            "province": "上海",
            "city": "上海",
            "county": "",
            "lnt": "121.472644",
            "lat": "31.231706"
        },
        "weather": {
            "dayWeather": "多云",
            "temperatureHigh": "21",
            "temperatureLow": "14"
        }
    }
}

失败

{
    "ret": 413,
    "info": "server_error",
    "message": "服务器错误",
    "dara": {}
}

生成短链接

接口描述:

将一个长链接转换成短链接。

请求路径: /server/generate/short-link

请求方式: POST

请求参数:

请求参数 参数类型 参数说明 是否必填
ori_link String 长链接

请求示例:

{
    "ori_link": "https://blog.mazey.net/tiny?id=4750321-221467d8-fc24-4930-8e97-d90c7313a63c"
}

返回参数:

返回参数 参数类型 参数说明 是否必有
ret Number 执行结果 0-成功 其他失败
info String 成功/失败代码
message String 成功/错误信息
data Object 数据
data.tiny_link String 短链接

返回示例:

成功

{
    "ret": 0,
    "info": "ok",
    "message": "成功",
    "data": {
        "tiny_link": "https://mazey.cn/t/ef"
    }
}

失败

{
    "ret": 413,
    "info": "server_error",
    "message": "服务器错误",
    "dara": {}
}

代理转发

接口描述:

代理转发,大部分时候应用于访问的接口受浏览器跨域限制,但是后端不方便修改的时候。

请求路径: /server/agent

请求方式: POST

请求参数:

请求参数 参数类型 参数说明 是否必填
method String 创建请求时使用的方法
url String 用于请求的服务器 URL
params Object 与请求一起发送的 URL 参数
data Object 作为请求主体被发送的数据

请求示例:

{
    "method": "post",
    "url": "https://example.mazey.cn/api/demo",
    "params": {
        "key": "413322"
    },
    "data": {
        "line": 1,
        "id": "10"
    }
}

返回参数:

返回参数 参数类型 参数说明 是否必有
ret Number 执行结果 0-成功 其他失败
info String 成功/失败代码
message String 成功/错误信息
data Object 数据

返回示例:

成功

{
    "ret": 0,
    "info": "ok",
    "message": "成功",
    "dara": {}
}

失败

{
    "ret": 413,
    "info": "server_error",
    "message": "服务器错误",
    "dara": {}
}

附录

本文档地址:https://blog.mazey.net/open-api

发表评论

电子邮件地址不会被公开。 必填项已用*标注