1. 介绍
该服务提供国家省市区/县数据接口;
支持代码本地部署&docker部署;
支持数据自更新;
2. 接口调用
2.1 获取省级数据
http://127.0.0.1:{port}
返回数据案例
[
{
"id": 1,
"code": "110000", // 城市编码
"name": "北京市", // 城市名称
"level": 1, // 级别,1省2市3区县
"ccode": "010", // 城市电话区号
"center": "116.407394,39.904211", // 城市中心经纬度
"parentid": -1 // 省级的父id是-1
},
...
]
2.2 获取城市列表
http://127.0.0.1:7001?pid={pid}&level=2
2.3 获取城市列表
http://127.0.0.1:7001?pid={pid}&level=3
3. 部署
3.1 常规部署
-
解压 maike-area.zip; 目录结构如下
- dist/ // 服务相关文件 - bootstrap.js // 服务启动入口 - areaConfig.txt // 省市区数据库插入指令 - package.json
-
在项目根目录执行指令
npm start // 服务默认监听7001端口; 可在package.json中配置
数据更改
项目启动后会在dist同级创建一个config文件夹,里面生成一个area.db数据库文件;为sqlite3库;用户可自己创建链接并修改。 需要注意的是: 因服务中有常驻数据缓存;修改数据库后,需要重新服务才会生效。
3.2 docker部署
- 拿到 maike-area-docker.tar文件后;执行如下命令导入镜像
docker load -i maike-area-docker.tar
- 执行如下命令生成docker实例
docker run -itd -p 7001:7001 --name area maike/area:1.0
- 如果有修改数据库的需求,可以把数据库映射出来
docker run -itd -p 7001:7001 --name area -v {pwd}/config:/app/config maike/area:1.0
3.3 docker-compose 部署
- 获取 maike-area-docker.tar时,会同步拿到 docker-compose.yml 文件;放到指定目录后,打开文件修改对应配置
version: '1' services: web: image: maike/area1.0 ports: - "7001:7001" volumes: - "./config:/app/config" restart: always container_name: 'area'
- 执行如下命令创建服务实例
docker-compose up
4. 获取服务
留言联系获取