@fastify/accepts-serializer

Serialize according to the Accept header.

Install

1npm i @fastify/accepts-serializer

Compatibility

Plugin version	Fastify version
^6.x	^5.x
^5.x	^4.x
^3.x	^3.x
^2.x	^2.x
^1.x	^1.x

Please note that if a Fastify version is out of support, then so are the corresponding version(s) of this plugin in the table above. See Fastify's LTS policy for more details.

Usage

1
2const protobuf = require('protobufjs')
3const YAML = require('yamljs')
4const msgpack = require('msgpack5')()
5
6const root = protobuf.loadSync('test/awesome.proto')
7const AwesomeMessage = root.lookupType('awesomepackage.AwesomeMessage')
8
9const fastify = require('fastify')()
10
11// Global serializers
12fastify.register(require('@fastify/accepts-serializer'), {
13  serializers: [
14    {
15      regex: /^application\/yaml$/,
16      serializer: body => YAML.stringify(body)
17    },
18    {
19      regex: /^application\/x-msgpack$/,
20      serializer: body => msgpack.encode(body)
21    }
22  ],
23  default: 'application/yaml' // MIME type used if Accept header don't match anything
24})
25
26// Per-router serializers
27const config = {
28  serializers: [
29    {
30      regex: /^application\/x-protobuf$/,
31      serializer: body => AwesomeMessage.encode(AwesomeMessage.create(body)).finish()
32    }
33  ]
34}
35
36fastify.get('/request', { config }, function (req, reply) {
37  reply.send({pippo: 'pluto'})
38})

Behaviour

For each route, a SerializerManager is defined, which has both per-route and global serializer definitions.

The MIME type application/json is always handled by fastify if no serializer is registered for that MIME type.

If no default key is specified in configuration, all requests with an unknown Accept header will be replied to with a 406 response (a boom error is used).

License

Licensed under MIT.