8000 GitHub - W-46ec/DailyCSS: DailyCSS后端程序 (node.js实现)
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

W-46ec/DailyCSS

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
bin
bin
 
 
public
public
 
 
routes
routes
 
 
tools
tools
 
 
views
views
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
app.js
app.js
 
 
package.json
package.json
 
 

Repository files navigation

Daily CSS 接口文档

[TOC]

接口约定

  1. 所有接口均采用GET或POST方式

接口详情

首页


首页

接口名称：/

接口类型：POST

是否需要Token：否

示例URL：http://127.0.0.1:3000


无请求参数列表


**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number| |favorite|收藏的dailyCss|| |dailyCss|随机显示的dailyCss| |msg|消息|string||
**响应示例** ```json { "code":200, "favorite":[], "dailyCss": { "_id": "5982940f00d6960df4180b6a", "username": "zxc110", "content": "早上下雨", "date": "2017-08-03 11:10:07", "id": "d70174a8-ece5-45eb-9f62-80a7853941dc" } "msg":"Welcome!" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|登陆成功|Welcome!|

获取在线人数

接口名称：/user/getonline

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/getonline


**无请求参数列表**
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string|| |data|用户列表|array|包括在线与离线用户，发起请求的用户排在数组的第一个元素| |number|在线人数|number|在线用户数量|
**响应示例** ```json { "code": 200, "data": [ { "username": "night", //请求者的用户名(排在第一个) "iat": 1506405723026, //最后一次请求的时间 "status": 1, //1表示在线，0表示离线 "blog": "a.com" //个人博客 }, { "username": "admin", "iat": 1506405700715, "status": 1, "blog": "b.com" }, { "username": "test", "iat": 0, "status": 0, "blog": "c.com" } ], "number": 2, //在线人数 "msg": "在线人数" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |200|获取成功|在线人数|

登陆模块


登陆

接口名称：/user/login

接口类型：POST

是否需要Token：否

示例URL：http://127.0.0.1:3000/user/login


**请求参数列表** |参数|含义|类型|备注| |---| |username|用户名|string|| |pwd|密码|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string|| |auth|授权码（Token）|string|登陆成功后才会获得| |username|用户名|string|登陆成功后才会获得|
**响应示例** ```json { "code":200, "auth":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNTAxNzI4MjIzLCJleHAiOjE1MDE3Mjg4MjN9.QjF4hsExvsBnpZwNajopLrklm3MXyMGxRzq6qFGBoFQ", "msg":"Welcome!" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |40010|用户名不存在|Username does not exist!| |40011|密码错误|Wrong password!| |200|登陆成功|Welcome!|
#### 注销

接口名称：/user/logout

接口类型：POST

是否需要Token：否

示例URL：http://127.0.0.1:3000/user/logout


**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code":200, "msg":"logout" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|注销成功|logout| |40016|非法Token|Invalid Token|

注册模块


#### 点击注册按钮

接口名称：/register

接口类型：POST

是否需要Token：否

示例URL：http://127.0.0.1:3000/register


**请求参数列表** |参数|含义|类型|备注| |---| |username|用户名|string|| |pwd|密码|string|| |reconfirmpwd|确认密码|string|| |email|邮箱|string|| |blog|个人博客|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code":200, "msg":"sent successfully" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |90010|用户名已存在|用户名已存在| |90011|参数错误|参数错误| |90015|邮件发送失败|邮件发送失败| |90016|邮件发送过于频繁|请于2分钟后再尝试| |200|邮件发送成功|sent successfully|
#### 点击验证链接

接口名称：/register

接口类型：GET

是否需要Token：否

示例URL：http://127.0.0.1:3000/register


**请求参数列表** |参数|含义|类型|备注| |---| |Token|授权码|string|已经拼接好在URL里|
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code":200, "msg":"success" } ```
**状态码详细定义** |状态码|含义|消息| |---| |90012|授权失败|授权失败| |90013|参数错误|参数错误| |90014|授权过期|授权过期| |200|注册成功|success|

找回密码模块


#### 验证用户名邮箱

接口名称：/lost/verifyuser

接口类型：POST

是否需要Token：否

示例URL：http://127.0.0.1:3000/lost/verifyuser


**请求参数列表** |参数|含义|类型|备注| |---| |username|用户名|string|| |email|邮箱|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code":200, "msg":"操作成功" } ```
**状态码详细定义** |状态码|含义|消息| |---| |100010|用户名不存在|用户名不存在| |100011|邮箱不正确|邮箱不正确| |200|操作成功|操作成功|
#### 发送验证码

接口名称：/lost/sendcode

接口类型：POST

是否需要Token：否

示例URL：http://127.0.0.1:3000/lost/sendcode


**请求参数列表** |参数|含义|类型|备注| |---| |username|用户名|string|| |email|邮箱|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code":200, "msg":"操作成功" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |100012|邮件发送失败|邮件发送失败| |100018|邮件发送过于频繁|请于1分钟后再尝试| |200|发送成功|发送成功|
#### 核实验证码

接口名称：/lost/verifycode

接口类型：POST

是否需要Token：否

示例URL：http://127.0.0.1:3000/lost/verifycode


**请求参数列表** |参数|含义|类型|备注| |---| |username|用户名|string|| |email|邮箱|string|| |code|验证码|string|
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string|| |auth|授权码（Token）|string|验证成功后才可获得|
**响应示例** ```json { "code":200, "msg":"验证成功" } ```
**状态码详细定义** |状态码|含义|消息| |---| |100013|验证码不正确|验证码不正确| |100014|验证信息过期|验证信息过期| |200|验证成功|验证成功|
#### 重置密码

接口名称：/lost/updatepwd

接口类型：POST

是否需要Token：是

示例URL：http://127.0.0.1:3000/lost/updatepwd


**请求参数列表** |参数|含义|类型|备注| |---| |pwd|密码|string|| |reconfirmpwd|确认密码|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code":100015, "msg":"无法找到Token" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |100015|无法找到Token|无法找到Token| |100016|验证信息过期|Token过期| |100017|参数错误|参数错误| |200|重置成功|重置成功|

Daily CSS模块


#### 添加dailyCss 接口名称：/user/dailycss/submit

接口类型：POST

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/daiilcss/submit


**参数列表** |参数|含义|类型|备注| |---| |dailycss|dailycss内容|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code": 200, "msg": "Insert Succeed" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|Insert Succeed|

收藏dailyCss

接口名称：/user/dailycss/collect

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/dailycss/collect?id=xxx


**参数列表** |参数|含义|类型|备注| |---| |id|连接dailycss|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code": 200, "msg": "收藏成功" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|收藏成功| |403|收藏失败|已收藏过该dailyCss|

删除dailyCss

接口名称：/user/dailycss/delete

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/dailycss/delete?id=xxx


**参数列表** |参数|含义|类型|备注| |---| |id|连接dailycss|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code": 200, "msg": "删除收藏成功" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|删除收藏成功|

评论模块


#### 添加评论 接口名称：/user/comment

接口类型：POST

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/comment?id=xxx


**参数列表** |参数|含义|类型|备注| |---| |comment|评论内容|string|| |id|连接DailyCss|string|
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code": 200, "msg": "Comment Succeed" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|Comment Succeed|

查看评论

接口名称：/user/comment

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/comment?id=xxx


**参数列表** |参数|含义|类型|备注| |---| |id|连接DailyCss|string|
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |data|评论内容|string |dailyCss|被评论内容|string |msg|消息|string||
**响应示例** ```json { "code": 200, "data":[{ "_id": "5982c9e1b73b0d36b43943dc", "id": "d70174a8-ece5-45eb-9f62-80a7853941dc", "commentator": "honor", "comment": "花菜是菜花", "date": "2017-08-03 14:59:45", "author": "zxc110", "status": "1" }, ……], "dailyCss": { "_id": "5982940f00d6960df4180b6a", "username": "zxc110", "content": "早上下雨", "date": "2017-08-03 11:10:07", "id": "d70174a8-ece5-45eb-9f62-80a7853941dc" }, "msg": "Comment Succeed" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|Comment Succeed|

未查看评论个数

接口名称：/user/comment

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/count


**无请求参数列表**
**响应参数列表** |参数|含义|类型|备注| |---| |data|未查看评论的总数|number|
**响应示例** ```json { "code": 200, "data":3 "msg": "未查看评论总数" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|Comment Succeed|

个人信息模块

查看备忘录

接口名称：/user/person/memo

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/person/memo?username=xxx


**无请求参数列表**
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |data|数据|object|| |msg|消息|string||
**响应示例** ```json { "code": 200, "data": [ { "_id": "598297c8f8c0f220980a5f79", "id": "5", "username": "honor", "time": "周四", "thing": "睡觉" }], "msg": "成功查看备忘录" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|成功查看备忘录|

修改备忘录

接口名称：/user/person/memo

接口类型：POST

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/person/memo?username=xxx


**请求参数列表** |参数|含义|类型|备注| |---| |id|第几条便签|number|| |time|时间|string|| |thing|做什么|string||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |data|数据|object|| |msg|消息|string||
**响应示例** ```json { "code": 200, "data": [ "code":200, "msg":"成功更新备忘录" }], "msg": "成功更新备忘录" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|成功更新备忘录|
#### 获取个人资料

接口名称：/user/person/personaldetail

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/person/personaldetail


**无请求参数列表**
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |data|数据|object|| |msg|消息|string||
**响应示例** ```json { "code": 200, "data": { "username": "admin", "blog": "admin.blog", "email": "admin@css.com" }, "msg": "personaldetail" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |70010|Token不合法或过期|Invalid token| |200|请求成功|personaldetail|
#### 更改个人博客

接口名称：/person/updateblog

接口类型：POST

是否需要Token：是

示例URL：http://127.0.0.1:3000/person/updateblog


**请求参数列表** |参数|含义|类型|备注| |---| |blog|博客|string|更新后的博客|
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |msg|消息|string||
**响应示例** ```json { "code":200, "msg":"success" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |70010|Token不合法或过期|Invalid token| |200|修改成功|success|

头像传输模块


#### 上传头像

接口名称：/user/files/upload

接口类型：POST

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/files/upload


**无请求参数列表**
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |filename|上传头像的URL|string|| |msg|消息|string||
**响应示例** ```json { "code": 200, "filename": "/upload/6b744183eac159393217bbc6db04e59dadmin.jpg", "msg": "success" } ```
**状态码详细定义** |状态码|含义|消息| |---| |80010|Token不合法或过期|Invalid token| |80011|上传失败|failed| |200|上传成功|success| |500|服务器错误|Error|
#### 获取头像URL列表（部分）

接口名称：/user/files/getfiles

接口类型：POST

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/files/getfiles


**请求参数列表** |参数|含义|类型|备注| |---| |usernames|用户名列表|array||
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |data|返回值|array|请求头像的用户名和URL对象列表，没有则URL为默认路径| |msg|消息|string||
**请求示例** ```json { "usernames": [ "admin", "test" ] } ```
**响应示例** ```json { "code": 200, "data": [{ "username": "admin", "filename": "/upload/6b744183eac159393217bbc6db04e59dadmin.jpg" },{ "username": "test", "filename": "/upload/default.png" }], "msg": "files" } ```
**状态码详细定义** |状态码|含义|消息| |---| |200|请求成功|files| |80010|Token不合法或过期|Invalid token| |500|服务器错误|Error|
#### 获取全部用户的头像URL列表

接口名称：/user/files/getallfiles

接口类型：GET

是否需要Token：是

示例URL：http://127.0.0.1:3000/user/files/getallfiles


**无请求参数列表**
**响应参数列表** |参数|含义|类型|备注| |---| |code|状态值|number|| |data|返回值|array|请求成功时返回| |msg|消息|string||
**响应示例** ```json { "code": 200, "data": [{ "/upload/6b744183eac159393217bbc6db04e59dadmin.jpg" }], "msg": "success" } ```
**状态码详细定义** |状态码|含义|消息| |---| |500|服务器错误|Error| |200|请求成功|success|

附录

附录Ⅰ（模块路由与状态码分发）

|模块|绑定路由|状态码开头|状态码位数| |---| |主页|/...|300**|5| |登陆模块|/user/...|400**|5| |注册模块|/...|900**|5| |找回密码模块|/lost/...|1000**|6| |Daily CSS模块|/user/dailycss/...|500**|5| |评论模块|/user/comment/...|600**|5| |个人信息模块|/user/personal/...|700**|5| |头像传输模块|/user/files/...|800**|5|

附录Ⅱ（状态码汇总）

附录Ⅲ

About

DailyCSS后端程序 (node.js实现)

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages
0