feat: add cnode api async example (#22)

Author: SF-Zhou

cnode-api-async/.autod.conf.js

@@ -0,0 +1,26 @@
+'use strict';
+
+module.exports = {
+ write: true,
+ prefix: '^',
+ test: [
+ 'test',
+ 'benchmark',
+ ],
+ dep: [
+ ],
+ devdep: [
+ 'egg-ci',
+ 'egg-bin',
+ 'autod',
+ 'eslint',
+ 'eslint-config-egg',
+ 'supertest',
+ 'webstorm-disable-index',
+ ],
+ exclude: [
+ './test/fixtures',
+ './dist',
+ ],
+};
+

cnode-api-async/.eslintignore

@@ -0,0 +1,2 @@
+test/fixtures
+coverage

cnode-api-async/.eslintrc

@@ -0,0 +1,15 @@
+{
+ "extends": "eslint-config-egg",
+ "parserOptions": {
+ "ecmaVersion": 2017
+ },
+ "rules": {
+ },
+ "globals": {
+ "app": true,
+ "request": true,
+ "mm": true,
+ "mock": true,
+ "assert": true
+ }
+}

cnode-api-async/.gitignore

@@ -0,0 +1,9 @@
+logs/
+npm-debug.log
+node_modules/
+coverage/
+.idea/
+run/
+.DS_Store
+*.swp
+

cnode-api-async/README.md

@@ -0,0 +1,33 @@
+# cnode-api-async
+
+
+
+## QuickStart
+
+<!-- add docs here for user -->
+
+see [egg docs][egg] for more detail.
+
+### Development
+```shell
+$ npm install
+$ npm run dev
+$ open http://localhost:7001/news
+```
+
+### Deploy
+
+Use `EGG_SERVER_ENV=prod` to enable prod mode
+
+```shell
+$ EGG_SERVER_ENV=prod npm start
+```
+
+### npm scripts
+
+- Use `npm run lint` to check code style.
+- Use `npm test` to run unit test.
+- Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.
+
+
+[egg]: https://eggjs.org

cnode-api-async/README.zh-CN.md

@@ -0,0 +1,38 @@
+# cnode-api-async
+
+
+
+## 快速入门
+
+<!-- 在此次添加使用文档 -->
+
+如需进一步了解，参见 [egg 文档][egg]。
+
+### 本地开发
+```bash
+$ npm install
+$ npm run dev
+$ open http://localhost:7001/news
+```
+
+### 部署
+
+线上正式环境用 `EGG_SERVER_ENV=prod` 来启动。
+
+```bash
+$ EGG_SERVER_ENV=prod npm start
+```
+
+### 单元测试
+- [egg-bin] 内置了 [mocha], [thunk-mocha], [power-assert], [istanbul] 等框架，让你可以专注于写单元测试，无需理会配套工具。
+- 断言库非常推荐使用 [power-assert]。
+- 具体参见 [egg 文档 -单元测试](https://eggjs.org/zh-cn/core/unittest)。
+
+### 内置指令
+
+- 使用 `npm run lint` 来做代码风格检查。
+- 使用 `npm test` 来执行单元测试。
+- 使用 `npm run autod` 来自动检测依赖更新，详细参见 [autod](https://www.npmjs.com/package/autod) 。
+
+
+[egg]: https://eggjs.org

cnode-api-async/app.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const co = require('co');
+
+module.exports = app => {
+ app.curl = co.wrap(app.curl);
+};

cnode-api-async/app/controller/topics.js

@@ -0,0 +1,64 @@
+'use strict';
+
+module.exports = app => {
+ class TopicsController extends app.Controller {
+ constructor(ctx) {
+ super(ctx);
+
+ this.createRule = {
+ accesstoken: 'string',
+ title: 'string',
+ tab: { type: 'enum', values: [ 'ask', 'share', 'job' ], required: false },
+ content: 'string',
+ };
+ }
+
+ async show() {
+ const { ctx } = this;
+
+ ctx.body = await ctx.service.topics.show({
+ id: ctx.params.id,
+ mdrender: ctx.query.mdrender !== 'false',
+ accesstoken: ctx.query.accesstoken || '',
+ });
+ }
+
+ async index() {
+ const { ctx } = this;
+
+ ctx.validate({
+ page: { format: /\d+/, required: false },
+ tab: { type: 'enum', values: [ 'ask', 'share', 'job', 'good' ], required: false },
+ limit: { format: /\d+/, required: false },
+ }, ctx.query);
+
+ ctx.body = await ctx.service.topics.list({
+ page: ctx.query.page,
+ tab: ctx.query.tab,
+ limit: ctx.query.limit,
+ mdrender: ctx.query.mdrender !== 'false',
+ });
+ }
+
+ async create() {
+ const { ctx } = this;
+ ctx.validate(this.createRule);
+
+ const id = await ctx.service.topics.create(ctx.request.body);
+ ctx.body = {
+ topic_id: id,
+ };
+ ctx.status = 201;
+ }
+
+ async update() {
+ const { ctx } = this;
+
+ ctx.validate(this.createRule);
+ await ctx.service.topics.update(ctx.params.id, ctx.request.body);
+ ctx.status = 204;
+ }
+ }
+
+ return TopicsController;
+};

cnode-api-async/app/middleware/error_handler.js

@@ -0,0 +1,23 @@
+'use strict';
+
+module.exports = (option, app) => {
+ return async function(ctx, next) {
+ try {
+ await next();
+ } catch (err) {
+ // 所有的异常都在 app 上触发一个 error 事件，框架会记录一条错误日志
+ app.emit('error', err, this);
+ const status = err.status || 500;
+ // 生产环境时 500 错误的详细错误内容不返回给客户端，因为可能包含敏感信息
+ const error = status === 500 && app.config.env === 'prod'
+ ? 'Internal Server Error'
+ : err.message;
+ // 从 error 对象上读出各个属性，设置到响应中
+ ctx.body = { error };
+ if (status === 422) {
+ ctx.body.detail = err.errors;
+ }
+ ctx.status = status;
+ }
+ };
+};

cnode-api-async/app/router.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = app => {
+ app.resources('topics', '/api/v2/topics', 'topics');
+};