🌜
🌞
@middy/http-json-body-parser

@middy/http-json-body-parser

v3.1.1

Http JSON body parser middleware for the middy framework

npm install @middy/http-json-body-parser

README

Middy http-json-body-parser middleware

Middy logo

HTTP json body parser middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

npm version npm install size GitHub Actions CI status badge
Standard Code Style Known Vulnerabilities Language grade: JavaScript Core Infrastructure Initiative (CII) Best Practices
Chat on Gitter Ask questions on StackOverflow

You can read the documentation at: https://middy.js.org/docs/middlewares/http-json-body-parser

This middleware automatically parses HTTP requests with a JSON body and converts the body into an object. Also handles gracefully broken JSON as UnprocessableEntity (422 errors) if used in combination with httpErrorHandler.

It can also be used in combination with validator as a prior step to normalize the event body input as an object so that the content can be validated.

If the body has been parsed as JSON, you can access the original body (e.g. for webhook signature validation) through the request.event.rawBody.

Install

To install this middleware you can use NPM:

npm install --save @middy/http-json-body-parser

Options

  • reviver (function) (default undefined): A reviver parameter may be passed which will be used JSON.parseing the body.

Sample usage

import middy from '@middy/core'
import httpHeaderNormalizer from '@middy/http-header-normalizer'
import httpJsonBodyParser from '@middy/http-json-body-parser'

const handler = middy((event, context) => {
  return {}
})

handler
  .use(httpHeaderNormalizer())
  .use(httpJsonBodyParser())

// invokes the handler
const event = {
  headers: {
    'Content-Type': 'application/json'  // It is important that the request has the proper content type.
  },
  body: JSON.stringify({foo: 'bar'})
}
handler(event, {}, (_, body) => {
  t.is(body,{foo: 'bar'})
})

Middy documentation and examples

For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

License

Licensed under MIT License. Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the Middy team.

FOSSA Status

Release Notes

3.1.1
By will Farrell • Published on August 4, 2022

What's Changed

  • Add in module to package.json files @willfarrell
  • performance improvements @willfarrell

TypeScript

Docs

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.1.0...3.1.1

3.1.0
By will Farrell • Published on June 21, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.4...3.1.0

3.0.4
By will Farrell • Published on June 4, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.3...3.0.4

3.0.3
By will Farrell • Published on May 17, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.2...3.0.3

3.0.2
By will Farrell • Published on May 13, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.1...3.0.2

3.0.1
By will Farrell • Published on May 13, 2022

What's Changed

  • Updated dependencies

Full Changelog: https://github.com/middyjs/middy/compare/3.0.0...3.0.1

2.5.7
By will Farrell • Published on January 25, 2022

Fix publishing transpiling error in 2.5.6. Thanks to @maximepichou and @rreubenreyes for reporting.

General

License
MIT
Typescript Types
Built-in
Tree-shakeable
Yes

Popularity

GitHub Stargazers
3,033
Community Interest
2,905
Number of Forks
293

Maintenance

Commits
10/219/220250
Last Commit
Open Issues
4
Closed Issues
409
Open Pull Requests
1
Closed Pull Requests
149

Versions

Versions Released
10/219/22010
Latest Version Released
Aug 4, 2022
Current Tags
latest3.1.1
next3.1.0-rc.1

Dependencies

Dependencies (1)
Dev Dependencies (2)

Contributors

willfarrell
willfarrell
Commits: 384
lmammino
lmammino
Commits: 113
greenkeeper[bot]
greenkeeper[bot]
Commits: 12
vladgolubev
vladgolubev
Commits: 12
thejuan
thejuan
Commits: 12
dkatavic
dkatavic
Commits: 11
gsingh1
gsingh1
Commits: 10
joseSantacruz
joseSantacruz
Commits: 9
theburningmonk
theburningmonk
Commits: 6
leog
leog
Commits: 6
ossareh
ossareh
Commits: 5
JimiPedros
JimiPedros
Commits: 4
munierujp
munierujp
Commits: 4
sdomagala
sdomagala
Commits: 4
denovodavid
denovodavid
Commits: 3