new

Author: wangjingbo

.gitignore

@@ -0,0 +1,27 @@
+# Logs
+logs
+*.log
+.vscode
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules

README.md

@@ -0,0 +1,25 @@
+#backend-pratt API
+
+###1. 运行环境
+* nodejs  v6.9.1
+* 运行方式
+
+	> 如果没有数据模型，初始化数据模型 
+	
+	```javascript
+	npm run sync
+	```
+	
+	> 运行系统 **端口可自定义配置 文件config port: 3001**
+	
+	```javascript
+	npm start
+	```
+	
+### 2. 数据库模型
+
+[数据库设计](doc/model.md)
+
+### 3. API
+
+[API规范](doc/api.md)

app.js

@@ -0,0 +1,32 @@
+'use strict';
+let Application       = require('koa');
+let compress          = require('koa-compress');
+let bodyParser        = require('koa-bodyparser');
+let _router           = require('koa-router')();
+let logger            = require('koa-logger');
+let cors              = require('koa-cors');
+
+let config            = require('./config/config.js');
+let routes            = require('./routes.js');
+
+let app = Application();
+// 日志记录
+app.use(logger());
+
+// 跨域
+app.use(cors());
+
+// body 解析
+app.use(bodyParser());
+
+routes.init(_router);
+
+app.use(_router.routes());
+
+
+// Compress
+app.use(compress());
+
+app.listen(config.port || 3000);
+console.log('listening on port %s', config.port || 3000);
+module.exports = app;

config/config.js

@@ -0,0 +1,18 @@
+'use strict';
+
+let config = {
+  // 端口号配置
+  port: 3000,
+  // 数据库配置
+  db: {
+    host: '127.0.0.1',
+    dialect: 'mysql',
+    port: '3306',
+    database: 'test',
+    username: 'root',
+    password: '123456'
+  },
+}
+
+//当NODE_ENV环境变量值为development时 
+module.exports = config

doc/api.md

@@ -0,0 +1,242 @@
+### backend API设计
+---
+
+### 1. GET规范
+
+* 请求规范
+
+	```javascript
+	req = {
+		current: 1,
+		pageSize: 10,
+		isPage: 1
+		children: 0 
+	}
+	```
+* 响应规范
+
+	```javascript
+	resp = {
+		code: 0,
+		message: string,
+		content: {
+			total: 1,
+			current: 1,
+			pageSize: 10,
+			data: [] || {}
+		}
+	}
+	```
+	
+### 2. POST规范
+* 请求规范
+
+	```
+	body = JSON.stringify()
+	
+	```
+* 响应规范
+
+	```javascript
+	resp = {
+		code,
+		message: 'ok',
+		content: number
+	}
+	
+	```
+	
+### 3. PUT规范
+* 请求规范
+
+	```
+	ulr = url/:id
+	body = JSON.stringify()
+	
+	```
+* 响应规范
+
+	```javascript
+	resp = {
+		code,
+		message: 'ok'
+	}
+	```
+	
+### 4.DELETE规范
+
+* 请求规范
+
+	```
+	url = url/:id	
+	```
+
+* 响应规范
+
+	```javascript
+	resp = {
+		code,
+		message: 'ok'
+	}
+	```	
+	
+### 5. 相应状态码
+```
+code 解析码
+
+{
+    code: 0, //正常
+    code: 1, //API 异常
+    code: 2, //参数错误
+}
+```
+
+###6. API 请求路径
+	
+*  navgation 导航
+
+	```javascript
+	// 获取所有
+	{
+		method: GET,
+		endpoint: '/navgations'
+		response: {}
+	}
+	
+	// 获取单个
+	{
+		method: GET,
+		endpoint: '/navgation/:id'
+		response: {}
+	}
+	
+	// 更新数据
+	{
+		method: PUT,
+		endpoint: '/navgation/:id'
+		response: {}
+	}
+	```
+	
+*  classify 分类
+
+	```javascript
+	// 获取所有
+	{
+		method: GET,
+		endpoint: '/classifys'
+		response: {}
+	}
+	
+	// 获取单个
+	{
+		method: GET,
+		endpoint: '/classify/:id'
+		response: {}
+	}
+	// 插入数据
+	{
+		method: POST,
+		endpoint: '/classify'
+		response: {}
+	}
+	
+	// 更新某个
+	{
+		method: PUT,
+		endpoint: '/classify/:id'
+		response: {}
+	}
+	// 删除数据
+	{
+		method: DELETE,
+		endpoint: '/classify/:id'
+		response: {}
+	}
+	```
+	
+*  aritle 分类
+
+	```javascript
+	// 获取所有
+	{
+		method: GET,
+		endpoint: '/aritles'
+		response: {}
+	}
+	
+	// 获取单个
+	{
+		method: GET,
+		endpoint: '/aritle/:id'
+		response: {}
+	}
+	// 插入数据
+	{
+		method: POST,
+		endpoint: '/aritle'
+		response: {}
+	}
+	
+	// 更新某个
+	{
+		method: PUT,
+		endpoint: '/aritle/:id'
+		response: {}
+	}
+	// 删除数据
+	{
+		method: DELETE,
+		endpoint: '/aritle/:id'
+		response: {}
+	}
+	```
+	
+*  carousel 轮播
+
+	```javascript
+	// 获取所有
+	{
+		method: GET,
+		endpoint: '/carousels'
+		response: {}
+	}
+	
+	// 获取单个
+	{
+		method: GET,
+		endpoint: '/carousel/:id'
+		response: {}
+	}
+	// 插入数据
+	{
+		method: POST,
+		endpoint: '/carousel'
+		response: {}
+	}
+	
+	// 更新某个
+	{
+		method: PUT,
+		endpoint: '/carousel/:id'
+		response: {}
+	}
+	// 删除数据
+	{
+		method: DELETE,
+		endpoint: '/carousel/:id'
+		response: {}
+	}
+	```
+* 上传文件
+
+```javascript
+	{
+		method: POST
+		endpoint: '/upload',
+		body: {
+			multipart/form-data
+		},
+		response: { "返回文件服务的URL"}
+	}
+```