接口速览

1. 存活检测

路径：/

返回格式: json

返回字段：

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
message	str	返回消息，Service is running!表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)

返回示例:

{
    "status": "success",
    "message": "Service is running!",
    "timestamp": 1742830394298
}

2. 智能推荐景点[AI交互]

路径：/smart-plan

请求方法: POST

请求格式: json

请求字段:

字段名	类型	描述
location	str	用户定位街道信息
input	str	用户的要求

请求示例:

{
    "location": "北京市海淀区中关村大街",
    "input": "我想去一个有趣的地方"
}

返回格式: json

返回字段:

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)
data	list	返回数据列表，每个元素是一个景点名称

返回示例:

{
    "status": "success",
    "timestamp": 1742830394298,
    "data": [
        "颐和园",
        "圆明园遗址公园",
    ]
}

3. 所有景点信息

路径：/destinations

请求方法: GET

返回格式: json

返回字段:

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)
data	list	返回数据列表，每个元素是一个景点信息

景点信息字段:

字段名	类型	描述
name	str	景点名称
description	str	景点描述
lng	float	经度
lat	float	纬度
id	int	景点ID

4. 景点信息[WIP]

路径：/destination/<int:destination_id>

请求方法: GET

返回格式: json

返回字段:

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)
data	dict	返回数据字典，包含景点信息

景点信息字段:

字段名	类型	描述
name	str	景点名称
description	str	景点描述
lng	float	经度
lat	float	纬度
id	int	景点ID

5. 路径信息[WIP]

路径：/routes

请求方法: POST

请求格式: json

请求字段:

字段名	类型	描述
origin	str	起点(geoLocation|景点名)
destination	str	终点(geoLocation|景点名)
mode	str	出行方式(driving|walking|cycling|transit)
geoLocation	dict{lng: float, lat: float}	地理位置信息

请求示例:

{
    "origin": "geoLocation",
    "destination": "圆明园遗址公园",
    "mode": "driving",
    "geoLocation": {
        "lng": 116.303843,
        "lat": 39.992865
    }
}

返回格式: json

返回字段:

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)
data	dict	返回数据字典，包含路径信息

路径信息字段:

字段名	类型	描述
origin	str	起点
destination	str	终点
mode	str	出行方式
minTime	int	最短时间(分钟)
minDistance	float	最短距离(公里)
plans	list	路径规划列表，每个元素是一个路径规划

路径规划字段:

字段名	类型	描述
time	int	时间(分钟)
distance	float	距离(公里)

6. 修改景点[WIP][AI交互]

路径：/modify-plan

请求方法: POST

请求格式: json

请求字段:

字段名	类型	描述
location	str	用户定位街道信息
input	str	用户的要求
plan	list	用户的原先计划列表，每个元素是一个景点名称

请求示例:

{
    "location": "北京市海淀区中关村大街",
    "input": "圆明园我去过了",
    "plan": [
        "颐和园",
        "圆明园遗址公园"
    ]
}

返回格式: json

返回字段:

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)
data	list	返回数据列表，每个元素是一个景点名称

返回示例:

{
    "status": "success",
    "timestamp": 1742830394298,
    "data": [
        "颐和园",
        "天安门广场",
    ]
}

7. 预算判定[WIP][AI交互]

路径：/budget

请求方法: POST

请求格式: json

请求字段:

字段名	类型	描述
input	str	用户的要求
beginTime	str	开始时间，格式为YYYY-MM-DD HH:MM:SS
endTime	str	结束时间，格式为YYYY-MM-DD HH:MM:SS

请求示例:

{
    "input": "我想穷游"
}

返回格式: json

返回字段:

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)
data	list[int]	预算范围，包含两个整数，表示预算的下限和上限

返回示例:

{
    "status": "success",
    "timestamp": 1742830394298,
    "data": [100, 500]
}

8. 时间判定[WIP][AI交互]

路径：/time

请求方法: POST

请求格式: json

请求字段:

字段名	类型	描述
input	str	用户的要求
currentTime	str	当前时间，格式为YYYY-MM-DD HH:MM:SS

请求示例:

{
    "input": "我想在半天内游玩",
    "currentTime": "2023-10-01 08:00:00"
}

返回格式: json

返回字段:

字段名	类型	描述
status	str	服务状态，success表示服务正常运行
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)
data	dict	返回数据字典，包含时间范围信息

返回数据字典字段:

字段名	类型	描述
beginTime	str	开始时间，格式为YYYY-MM-DD HH:MM:SS
endTime	str	结束时间，格式为YYYY-MM-DD HH:MM:SS

返回示例:

{
    "status": "success",
    "timestamp": 1742830394298,
    "data": {
        "beginTime": "2023-10-01 08:00:00",
        "endTime": "2023-10-01 20:00:00"
    }
}

999. 错误代码

500 Internal Server Error

返回字段:

字段名	类型	描述
status	str	服务状态，error表示服务出错
message	str	返回消息，Internal Server Error表示服务内部错误
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)

返回示例:

{
    "status": "error",
    "message": "Internal Server Error",
    "timestamp": 1742830394298
}

404 Not Found

返回字段:

字段名	类型	描述
status	str	服务状态，error表示服务出错
message	str	返回消息，Not Found表示资源未找到
timestamp	int	时间戳，服务返回的时间戳(UTC, ms)

返回示例:

{
    "status": "error",
    "message": "Not Found",
    "timestamp": 1742830394298
}