|
|
@@ -1,6 +1,7 @@
|
|
|
-# 前言
|
|
|
+# Project
|
|
|
+
|
|
|
+此项目是 [vue2-elm](https://github.com/bailicangdu/vue2-elm) 的后台系统，保持和官网一致的API接口。
|
|
|
|
|
|
-电商系统对逻辑要求比较高，也比较复杂，作为nodejs练习的项目，对提升nodejs帮助绝对是很大的。但nodejs并不适合作为此类后台系统，这只是一个单纯的练习项目，所以请不要用于商业用途，此项目是 [vue2-elm](https://github.com/bailicangdu/vue2-elm) 的后台系统，保持和官网一致的API接口。所有的接口都是开放的，如果您也感兴趣，可以调用接口进行调试。
|
|
|
|
|
|
|
|
|
# 说明
|
|
|
@@ -69,6 +70,7 @@ npm run dev
|
|
|
- [ ] 上传头像
|
|
|
- [ ] 支付(支付宝，微信)
|
|
|
- [ ] 后台管理系统
|
|
|
+- [ ] 前后台同构，美化路由地址
|
|
|
- [ ] 部署上线
|
|
|
|
|
|
|
|
|
@@ -143,120 +145,9 @@ npm run dev
|
|
|
|
|
|
```
|
|
|
|
|
|
+# API接口文档
|
|
|
|
|
|
-# 接口文档
|
|
|
-
|
|
|
-## 目录:
|
|
|
-[1. 获取城市列表](#api_1)
|
|
|
-
|
|
|
-[2. 获取所选城市信息](#api_2)
|
|
|
-
|
|
|
-[3. 搜索地址](#api_3)
|
|
|
-
|
|
|
-
|
|
|
-```
|
|
|
-说明：baseUrl: http:www.cangdu.org
|
|
|
-```
|
|
|
-
|
|
|
-### 1.获取城市列表
|
|
|
-
|
|
|
-**请求URL**
|
|
|
-> baseUrl + '/v1/cities'
|
|
|
-
|
|
|
-**请求方式**
|
|
|
->**GET**
|
|
|
-
|
|
|
-**请求参数**
|
|
|
-
|
|
|
-|参数|是否必选|类型|说明|
|
|
|
-|:-----|:-------:|:-----|:-----|
|
|
|
-|type |Y |string |类型 guess：定位城市， hot：热门城市， group：所有城市 |
|
|
|
-
|
|
|
-**返回示例**
|
|
|
->
|
|
|
-```javascript
|
|
|
-{
|
|
|
- id: 1,
|
|
|
- name: "上海",
|
|
|
- abbr: "SH",
|
|
|
- area_code: "021",
|
|
|
- sort: 1,
|
|
|
- latitude: 31.23037,
|
|
|
- longitude: 121.473701,
|
|
|
- is_map: true,
|
|
|
- pinyin: "shanghai"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-### 2.获取所选城市信息
|
|
|
-
|
|
|
-**请求URL**
|
|
|
-> baseUrl + '/v1/cities/:id'
|
|
|
-
|
|
|
-**请求方式**
|
|
|
->**GET**
|
|
|
-
|
|
|
-**请求参数**
|
|
|
-
|
|
|
->
|
|
|
-|参数|是否必选|类型|说明|
|
|
|
-|:-----|:-------:|:-----|:-----|
|
|
|
-|id |Y |int |城市id |
|
|
|
-
|
|
|
-**返回示例**
|
|
|
->
|
|
|
-```javascript
|
|
|
-{
|
|
|
- id: 1,
|
|
|
- name: "上海",
|
|
|
- abbr: "SH",
|
|
|
- area_code: "021",
|
|
|
- sort: 1,
|
|
|
- latitude: 31.23037,
|
|
|
- longitude: 121.473701,
|
|
|
- is_map: true,
|
|
|
- pinyin: "shanghai"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-### 3.搜索地址
|
|
|
-
|
|
|
-**请求URL**
|
|
|
-> baseUrl + '/v1/pois'
|
|
|
-
|
|
|
-**请求方式**
|
|
|
->**GET**
|
|
|
-
|
|
|
-**请求参数**
|
|
|
-
|
|
|
->
|
|
|
-|参数|是否必选|类型|说明|
|
|
|
-|:-----|:-------:|:-----|:-----|
|
|
|
-|city_id |Y |int |城市id |
|
|
|
-|keyword |Y |string |搜索关键词 |
|
|
|
-|type |N |string |搜索类型，默认为search |
|
|
|
-
|
|
|
-**返回示例**
|
|
|
->
|
|
|
-```javascript
|
|
|
-[
|
|
|
- {
|
|
|
- name: "上海迪士尼乐园",
|
|
|
- address: "上海市浦东新区申迪西路753号",
|
|
|
- latitude: 31.14419,
|
|
|
- longitude: 121.66034,
|
|
|
- geohash: "31.14419,121.66034"
|
|
|
- },
|
|
|
- {
|
|
|
- name: "迪士尼",
|
|
|
- address: "上海市浦东新区妙境路1118号家乐福川沙店1层",
|
|
|
- latitude: 31.18183,
|
|
|
- longitude: 121.69279,
|
|
|
- geohash: "31.18183,121.69279"
|
|
|
- },
|
|
|
- ... //共10个数据
|
|
|
-]
|
|
|
-```
|
|
|
+* [接口文档](https://github.com/bailicangdu/node-elm/issues/3)
|
|
|
|
|
|
|
|
|
## License
|
maguohua