co-wechat-body

Parse wechat xml request body for Koa

Install

Usage

1const koa = require('koa');
2const wechatBodyParser = require('co-wechat-body');
3
4const app = koa();
5app.use(wechatBodyParser(<options>));
6
7app.use(function *() {
8    // the parsed body will store in this.request.body
9    // if nothing was parsed, body will be undefined
10    this.body = this.request.body;
11});

co-wechat-body will carefully check and set this.request.body, so it can intergate well with other body parsers such as koa-bodyparser:

1// ...
2const bodyParser = require('koa-bodyparser');
3
4// ...
5app.use(wechatBodyParser(<options>));
6app.use(bodyParser());

Example

http request raw body:

<xml>   
  <return_code><![CDATA[SUCCESS]]></return_code>  
  <return_msg><![CDATA[OK]]></return_msg> 
</xml>

parse result, this.request.body:

{
  "return_code": "SUCCESS",
  "return_msg": "OK"
}

Options

Please refer to (https://www.npmjs.com/package/koa-xml-body#options)

• encoding: requested encoding. Default is utf8. If not set, the lib will retrive it from content-type(such as content-type:application/xml;charset=gb2312).
• limit: limit of the body. If the body ends up being larger than this limit, a 413 error code is returned. Default is 1mb.
• length: length of the body. When content-length is found, it will be overwritten automatically.
• onerror: error handler. Default is a noop function. It means it will eat the error silently. You can config it to customize the response.

1app.use(xmlParser({
2    limit: 128,
3    length: 200, // '1mb'|1024... If not sure about the effect, just leave it unspecified
4    encoding: 'utf8', // lib will detect it from `content-type`
5    onerror: (err, ctx) => {
6        ctx.throw(err.status, err.message);
7    }
8}));

Licences

MIT