README.md

A Simple Message Board RESTful API

中文介绍点击 这里

Features

More Detail in package.json

• Express 4.x
• Express Auto Routes
• Lodash
• UUID

---

Requirements

• Node ≥ 4
• NPM ≥ 3

---

Getting Start

$ git clone https://github.com/kenberkeley/msg-board-api.git
$ cd msg-board-api
$ npm install
$ npm start

> msg-board-api@0.1.0 start /Users/kenberkeley/Documents/Desktop/msg-board-api
> node bin/start.js
[AutoMount] delete /msg/:msgId
[AutoMount] put /msg/:msgId
[AutoMount] get /msg/:msgId
[AutoMount] get /logout
[AutoMount] post /login
[AutoMount] get /user/
[AutoMount] post /msg/
[AutoMount] get /msg/
[INFO] Msg board RESTful API listening at localhost:8989

---

APIs

Showed as above

---

JSON Format

# A message example:
{
  "id":"4d48e8d0",
  "time":1465291755485,
  "author":"ken",
  "title":"hello world",
  "content":"welcome to msg-board-api"
}

# A session example:
{
  "username": "ken"
}

---

Testing

Make sure mocha available globally.
If not, npm i mocha -g

$ npm test
...