Skip to content

apiacademy/representor

Repository files navigation

Representor (Serializer)

MIT License CI Tests Status Build Status NPM Version  

Node.js implementation of a serializer for major Hypermedia Formats, in the context of Representor Pattern.

Installation

> npm install representor-serializer --save

Usage

var repserializer = require('representor-serializer');

var uber = repserializer(internal_representation, 'application/vnd.uber+json');

Included tests showcase examples of internal representation: https://github.com/apiacademy/representor/tree/master/test/fixtures

Currently Implemented Hypermedia Formats

  • HAL: application/hal+json (and application/vnd.hal+json for backwards-compatibility).
  • SIREN: application/vnd.siren+json
  • Collection+JSON: application/vnd.collection+json
  • UBER: application/vnd.uber+json

How to add a new serializer

@TODO

About

Node.js implementation of a serializer for major Hypermedia Formats, in the context of Representor Pattern.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published