增加开发文档和API文档|增加Profile|代码优化|todo:API完善|旅游去哈哈

Author: IndexXuan

.gitignore

@@ -8,4 +8,4 @@ run/
 .DS_Store
 *.swp
 out/
-
+todo.md

README.md

@@ -23,7 +23,8 @@
 
 ## Intro
 
-`V2EX API Bridge`: 提供论坛公开API的封装和私有API的挖掘实现，目前已支持 `登录，签到，发帖，回帖` 等非官方API功能.  
+`V2EX API Bridge`: 提供论坛公开API的封装和私有API的挖掘实现，目前已支持 `登录，签到，发帖，回帖，账户，消息` 等非官方API功能.  
+* see `app/router.js` to find full router config & demo api links
 
 - Thanks for：
 - [official API] (https://www.v2ex.com/p/7v9TEc53)
@@ -32,22 +33,25 @@
 ## Development
 
 - require Node.js 7.6.0+ (async & await)
-- recommend yarn install
+- recommend `yarn install`
 - recommend [nvm](https://github.com/creationix/nvm) - the Node.js Version Manager
 
 ```bash
 $ npm install
 $ npm run dev
 ```
-* see `app/router.js` to find full router config & demo api links
-
 ## Features
 
-- ✔︎ Full APIs Wrapped
-- ✔︎ RESTful Style
-- ✔︎ 30+ Case, 100%+ Unit Test(`BDD`)
-- ✔︎ Hot Reload in Dev
-- ✔︎ pre-commit hook to run cov & build docs and host in Github Pages @see `package.json`
+- ✔︎ Full RESTful Style APIs Wrapped
+- ✔︎ 40+ Case, 95%+ Unit Test(`BDD`) with Docs
+- ✔︎ Server Hot Reload in Dev
+- ✔︎ pre-commit hook to run codecov & build jsdoc, host in Github Pages @see `package.json#pre-commit`
+- ✔︎ CI Support
+
+## Docs
+
+- ✔︎ Public API Docs - [go] (https://indexxuan.github.io/v2ex-api-bridge/api/index.html)
+- ✔︎ Project Dev Docs - [go] (https://indexxuan.github.io/v2ex-api-bridge/project/index.html)
 
 ## Unit Test
 
@@ -57,16 +61,18 @@ $ npm run dev
 
 ## npm scripts
 
-- Use `npm start` to run server
+- Use `npm start` to run server in prod mode
 - Use `npm run dev` to dev
-- Use `npm run lint` to run eslint(eslint not native support es@next now)
+- Use `npm run lint` to run eslint(eslint not native support es@next now, so...)
 - Use `npm test` to run unit test
-- Use `npm run cov` to run cov
+- Use `npm run cov` to run code coverage
 
 ## Todo
 
-- make `pwa` using the APIs
 - parse the `response html` to get more private APIs
+- improve `docs` and 'codecov'
+- make `pwa` using the APIs
+- make it more `egg best practice`
 
 ## Links
 
@@ -77,4 +83,7 @@ $ npm run dev
 - [thunk-mocha] (https://npmjs.com/thunk-mocha)
 - [power-assert] (https://github.com/power-assert-js/power-assert)
 - [istanbul] (https://github.com/gotwarlost/istanbul)
+- [circleci] (https://circleci.com/)
+- [codecov] (https://codecov.io/)
+- [jsdoc] (https://github.com/jsdoc3/jsdoc)
 

app.js

@@ -0,0 +1,15 @@
+/**
+ * Author : IndexXuan(https://github.com/IndexXuan)
+ * Mail : indexxuan@gmail.com
+ * Date : Sat 01 Apr 2017 03:55:02 PM CST
+ */
+
+'use strict'
+
+module.exports = app => {
+ // class BaseService extends app.Service {
+ // }
+ // override
+ // app.Service = BaseService
+} // /.exports
+

app/api/auth.js

@@ -0,0 +1,52 @@
+/**
+ * Mail : indexxuan@gmail.com
+ * Date : Fri 03 Mar 2017 03:22:10 PM CST
+ */
+
+/**
+ * @module Auth
+ * @author IndexXuan
+ */
+
+'use strict'
+
+module.exports = app => prefix => {
+ /**
+ * 登录
+ * @method login
+ *
+ * @example
+ * POST /api/v2/auth/login
+ * data: { username: ${username}, password: ${password} }
+ *
+ * {
+ * result: true|false,
+ * msg: 'ok|${errormsg}',
+ * data: {
+ * username: ${username}
+ * }
+ * }
+ */
+ app.post('v2ex', `${prefix}/auth/login`, 'auth.login')
+ app.get('v2ex', `${prefix}/auth/login`, 'auth.login') // for test
+
+ /**
+ * 签到
+ * @method signin
+ *
+ * @example
+ * POST /api/v2/auth/signin
+ *
+ * {
+ * result: true|false,
+ * msg: 'ok|${errormsg: e.g. 今天已经签到了}',
+ * data: {
+ * username: ${username},
+ * detail: '已连续登录XX天'
+ * }
+ * }
+ */
+ app.post('v2ex', `${prefix}/auth/signin`, 'auth.signin')
+ app.get('v2ex', `${prefix}/auth/signin`, 'auth.signin') // for test
+}
+

app/api/members.js

@@ -0,0 +1,45 @@
+/**
+ * Mail : indexxuan@gmail.com
+ * Date : Fri 13 Mar 2017 03:22:10 PM CST
+ */
+
+/**
+ * @module Members
+ * @author IndexXuan
+ */
+
+'use strict'
+
+module.exports = app => prefix => {
+ /**
+ * 查看一个成员公开信息，无需权限
+ * @method show
+ *
+ * @example
+ * GET /api/v2/members/id/105309
+ * GET /api/v2/members/username/IndexXuan
+ *
+ * Object
+ * {
+ * "status": "found",
+ * "id": 105309,
+ * "url": "http://www.v2ex.com/member/IndexXuan",
+ * "username": "IndexXuan",
+ * "website": "",
+ * "twitter": "",
+ * "psn": "",
+ * "github": "",
+ * "btc": "",
+ * "location": "",
+ * "tagline": "",
+ * "bio": "",
+ * "avatar_mini": "//v2ex.assets.uxengine.net/gravatar/abda94899b0173bb17e815a5c0bf9e93?s=24&d=retro",
+ * "avatar_normal": "//v2ex.assets.uxengine.net/gravatar/abda94899b0173bb17e815a5c0bf9e93?s=48&d=retro",
+ * "avatar_large": "//v2ex.assets.uxengine.net/gravatar/abda94899b0173bb17e815a5c0bf9e93?s=73&d=retro",
+ * "created": 1426662703
+ * }
+ */
+ app.get('v2ex', `${prefix}/members/username/:username`, 'members.show')
+ app.get('v2ex', `${prefix}/members/id/:id`, 'members.show')
+}
+

app/api/nodes.js

@@ -0,0 +1,62 @@
+/**
+ * Mail : indexxuan@gmail.com
+ * Date : Fri 13 Mar 2017 03:22:10 PM CST
+ */
+
+/**
+ * @module Nodes
+ * @author IndexXuan
+ */
+
+'use strict'
+
+module.exports = app => prefix => {
+ /**
+ * 返回全部节点元信息
+ * @method all
+ *
+ * @example
+ * GET /api/v2/nodes/all
+ *
+ * Array<Object>
+ * [{
+ * "id": 249,
+ * "name": "vim",
+ * "url": "http://www.v2ex.com/go/vim",
+ * "title": "Vim",
+ * "title_alternative": "Vim",
+ * "topics": 405,
+ * "header": null,
+ * "footer": null,
+ * "created": 1289706010
+ * }, {
+ * ...
+ * }]
+ */
+ app.get('v2ex', `${prefix}/nodes/all`, 'nodes.all')
+
+ /**
+ * 返回一个特定节点信息
+ * @method show
+ *
+ * @example
+ * GET /api/v2/nodes/id/249
+ * GET /api/v2/nodes/name/vim
+ *
+ * Object
+ * {
+ * "id": 249,
+ * "name": "vim",
+ * "url": "http://www.v2ex.com/go/vim",
+ * "title": "Vim",
+ * "title_alternative": "Vim",
+ * "topics": 405,
+ * "header": null,
+ * "footer": null,
+ * "created": 1289706010
+ * }
+ */
+ app.get('v2ex', `${prefix}/nodes/id/:id`, 'nodes.show')
+ app.get('v2ex', `${prefix}/nodes/name/:name`, 'nodes.show')
+}
+

app/api/profile.js

@@ -0,0 +1,95 @@
+/**
+ * Mail : indexxuan@gmail.com
+ * Date : Fri 13 Mar 2017 03:22:10 PM CST
+ */
+
+/**
+ * @module Profile
+ * @author IndexXuan
+ */
+
+'use strict'
+
+module.exports = app => prefix => {
+ /**
+ * 返回本人全部信息，包含发布的主题，回复的主题，财富收支，消息通知等
+ * @method all 
+ *
+ * @example
+ * GET /api/v2/profile/all
+ *
+ * Array<Object> 
+ * [{
+ * "id": 4096325,
+ * "thanks": 0,
+ * "content": "站长辛苦了😆😆😆",
+ * "content_rendered": "站长辛苦了😆😆😆",
+ * "member": {
+ * "id": 154020,
+ * "username": "misaka19000",
+ * "tagline": "",
+ * "avatar_mini": "//v2ex.assets.uxengine.net/avatar/4271/6be2/154020_mini.png?m=1479258611",
+ * "avatar_normal": "//v2ex.assets.uxengine.net/avatar/4271/6be2/154020_normal.png?m=1479258611",
+ * "avatar_large": "//v2ex.assets.uxengine.net/avatar/4271/6be2/154020_large.png?m=1479258611"
+ * },
+ * "created": 1488489066,
+ * "last_modified": 1488489066
+ * }, {me
+ * ...
+ * }]
+ */
+ app.get('v2ex', `${prefix}/profile/all`, 'profile.all')
+
+ /**
+ * 返回本人发布的所有主题
+ * @method topics 
+ *
+ * @example
+ * GET /api/v2/profile/topics
+ *
+ * Array<Object> 
+ * [{
+ * }]
+ */
+ app.get('v2ex', `${prefix}/profile/topics`, 'profile.topics')
+
+ /**
+ * 返回本人的所有回复
+ * @method show
+ *
+ * @example
+ * GET /api/v2/profile/replies
+ *
+ * Array<Object> 
+ * [{
+ * }]
+ */
+ app.get('v2ex', `${prefix}/profile/replies`, 'profile.replies')
+
+ /**
+ * 返回本人所有收支情况
+ * @method balance
+ *
+ * @example
+ * GET /api/v2/profile/balance
+ *
+ * Array<Object> 
+ * [{
+ * }]
+ */
+ app.get('v2ex', `${prefix}/profile/balance`, 'profile.balance')
+
+ /**
+ * 返回本人所有的消息通知
+ * @method notification 
+ *
+ * @example
+ * GET /api/v2/profile/notification
+ *
+ * Array<Object> 
+ * [{
+ * }]
+ */
+ app.get('v2ex', `${prefix}/profile/notification`, 'profile.notification')
+} // /.exports
+