东区教室导航后端接口文档

API文档

目录

• 缩写单词说明

• 请求最短路径

  • 描述
  • 请求地址
  • 请求参数
  • 返回数据
  • 请求URL实例
  • 返回数据实例

• 错误状态码说明

缩写单词说明

请求最短路径

• 描述
  获取最短路径的接口

• 请求地址

  操作	path
  协议	HTTP
  数据格式	x-www-form-urlencoded
  方式	POST
  ULR全径	http://$variable/en/path

• 请求参数

  序号	参数名	必选	数据类型	长度	备注
  1	start	Y	String	1byte	必须为A-Z或a-z ASCLL字符
  2	end	N	String	1byte	目的地参数

• 返回数据

  序号	返回值	中文名称	备注
  1	code	请求状态码	200请求成功,400请求失败
  2	data	返回数据	json格式数据，字符串

• 请求URL实例
  http://localhost:8080/en/path
  POST /en/path HTTP/1.1
  Host: localhost:8080
  Content-Type: application/x-www-form-urlencoded
  Cache-Control: no-cache
  Postman-Token: 88998f5a-e3b8-dcd9-4ea5-4bd108b75cf9

start=A&end=B

• 返回数据实例

{
  "code": 200,
  "data": {
    "start": "A",
    "end": "B",
    "distance": 3,
    "path": "A->B"
  }
}

错误状态码说明