A blog system. Based on Vue2, Koa2, MongoDB and Redis
前后端分离 + 服务端渲染的博客系统, 前端 SPA + 后端 RESTful 服务器
前端：https://smallpath.me
后台管理截图：https://smallpath.me/post/blog-back-v2
- Node v6
- pm2
- MongoDB
- Redis
博客的提供RESTful API的后端
复制conf文件夹中的默认配置config.tpl, 并命名为config.js
有如下属性可以自行配置:
tokenSecret- 改为任意字符串
defaultAdminPassword- 默认密码, 必须修改, 否则服务器将拒绝启动
如果mongoDB或redis不在本机对应端口，可以修改对应的属性
mongoHostmongoDatabasemongoPortredisHostredisPort
如果需要启用后台管理单页的七牛图片上传功能，请再修改如下属性:
qiniuAccessKey- 七牛账号的公钥
qiniuSecretKey- 七牛账号的私钥
qiniuBucketHost- 七牛Bucket对应的外链域名
qiniuBucketName- 七牛Bucket的名称
qiniuPipeline- 七牛多媒体处理队列的名称
npm install
pm2 start entry.js
RESTful服务器在本机3000端口开启
博客的前台单页, 支持服务端渲染
复制server文件夹中的默认配置mongo.tpl, 并命名为mongo.js
如果mongoDB不在本机对应端口，请自行配置mongo.js中的属性:
mongoHostmongoDatabasemongoPort
npm install
npm run build
pm2 start production.js
请将logo.png与favicon.ico放至static目录中
再用nginx代理本机8080端口即可, 可以使用如下的模板
server{
listen 80; #如果是https, 则替换80为443
server_name *.smallpath.me smallpath.me; #替换域名
root /alidata/www/Blog/front/dist; #替换路径为构建出来的dist路径
set $node_port 3000;
set $ssr_port 8080;
location ^~ / {
proxy_http_version 1.1;
proxy_set_header Connection "upgrade";
proxy_pass http://127.0.0.1:$ssr_port;
proxy_redirect off;
}
location ^~ /proxyPrefix/ {
rewrite ^/proxyPrefix/(.*) /$1 break;
proxy_http_version 1.1;
proxy_set_header Connection "upgrade";
proxy_pass http://127.0.0.1:$node_port;
proxy_redirect off;
}
location ^~ /dist/ {
rewrite ^/dist/(.*) /$1 break;
etag on;
expires max;
}
location ^~ /static/ {
etag on;
expires max;
}
}
开发端口为本机8080
博客的后台管理单页
npm install
npm run build
用nginx代理构建出来的dist文件夹即可, 可以使用如下的模板
server{
listen 80; #如果是https, 则替换80为443
server_name admin.smallpath.me; #替换域名
root /alidata/www/Blog/admin/dist; #替换路径为构建出来的dist路径
set $node_port 3000;
index index.js index.html index.htm;
location / {
try_files $uri $uri/ @rewrites;
}
location @rewrites {
rewrite ^(.*)$ / last;
}
location ^~ /proxyPrefix/ {
rewrite ^/proxyPrefix/(.*) /$1 break;
proxy_http_version 1.1;
proxy_set_header Connection "upgrade";
proxy_pass http://127.0.0.1:$node_port;
proxy_redirect off;
}
location ^~ /static/ {
etag on;
expires max;
}
}
开发端口为本机8082
后端服务器默认开启在 3000 端口, 如不愿意暴露 IP, 可以自行设置 nginx 代理, 或者直接使用前端两个单页的代理前缀/proxyPrefix
例如, demo的API根目录如下:
其中, :modelName为模型名, 总计如下6个模型
post
theme
tag
category
option
user
:id为指定的文档ID, 用以对指定文档进行 CRUD
支持如下五种:
GET //查询
POST //新建
PUT //替换
PATCH //更新部分属性
DELETE //删除指定ID的文档有如下两个规定:
- 对所有请求
- header中必须将
Content-Type设置为application/json, 需要body的则body必须是合法 JSON格式
- header中必须将
- 对所有回应
- header中的
Content-Type均为application/json, 且返回的数据也是 JSON格式
- header中的
服务器直接允许对user模型外的所有模型的GET请求
user表的所有请求, 以及其他表的非 GET 请求, 都必须将 header 中的authorization设置为服务器下发的 Token, 服务器验证通过后才会继续执行 CRUD 操作
body格式如下:
{
"name": "admin",
"password": "testpassword"
}
成功, 则返回带有token字段的 JSON 数据
{
"status": "success",
"token": "tokenExample"
}
失败, 则返回如下格式的 JSON 数据:
{
"status": "fail",
"description": "Get token failed. Check name and password"
}
获取到token后, 在上述需要 token 验证的请求中, 请将 header 中的authorization设置为服务器下发的 Token, 否则请求将被服务器拒绝
将header中的authorization设置为服务器下发的 token, 即可撤销此 token
Token 默认有效期为获得后的一小时, 超出时间后请重新请求 Token
如需自定义有效期, 请修改服务端配置文件中的tokenExpiresIn字段, 其单位为秒
服务器直接允许对user模型外的所有模型的 GET 请求, 不需要验证 Token
为了直接通过 URI 来进行 mongoDB 查询, 后台提供六种关键字的查询:
conditions,
select,
count,
sort,
skip,
limit
类型为JSON, 被解析为对象后, 直接将其作为mongoose.find的查询条件
GET https://smallpath.me/proxyPrefix/api/post?conditions={"title":"关于"}
类型为JSON, 用以拾取每条数据所需要的属性名, 以过滤输出来加快响应速度
获得查询结果的数量
GET https://smallpath.me/proxyPrefix/api/post?conditions={"type":0}&count=1
GET https://smallpath.me/proxyPrefix/api/post?sort={"_id":-1}
GET https://smallpath.me/proxyPrefix/api/post?sort={"updatedAt":-1}
GET https://smallpath.me/proxyPrefix/api/post?limit=10&skip=10&sort=1
需要验证Token
Body中为用来新建文档的JSON数据
每个模型的具体字段, 可以查看该模型的Schema定义来获得
需要验证Token
:id为查询到的文档的_id属性, Body中为用来替换该文档的JSON数据
需要验证Token
:id为查询到的文档的_id属性, Body中为用来更新该文档的JSON数据
更新操作请使用PATCH而不是PUT
需要验证 Token
删除指定 ID 的文档
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent