v2ex-api-bridge

Intro

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)
• [V2EX-API] (https://github.com/djyde/V2EX-API)

Development

• require Node.js 7.6.0+ (async & await)
• recommend yarn install
• recommend nvm - the Node.js Version Manager

$ npm install
$ npm run dev

Features

• ✔︎ 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

• mocha, thunk-mocha, power-assert, istanbul is build-in to egg-bin, so you can just use it.
• power-assert is very powerful, No API is the best API.
• see egg unit test docs for more detail.

npm scripts

• 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, so...)
• Use npm test to run unit test
• Use npm run cov to run code coverage

Todo

• 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

• [V2EX] (https://www.v2ex.com/)
• [egg] (https://github.com/eggjs/egg)
• [egg-bin] (https://github.com/eggjs/egg-bin)
• [mocha] (http://mochajs.org)
• [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)