Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raido/ember-json-serializer-meta
Extensive metadata support for Ember Data JSONSerializer
https://github.com/raido/ember-json-serializer-meta
addon ember ember-data json-api serializer
Last synced: about 1 month ago
JSON representation
Extensive metadata support for Ember Data JSONSerializer
- Host: GitHub
- URL: https://github.com/raido/ember-json-serializer-meta
- Owner: raido
- License: mit
- Archived: true
- Created: 2016-01-09T11:38:36.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2017-09-10T11:25:23.000Z (about 7 years ago)
- Last Synced: 2024-09-20T12:30:52.972Z (about 2 months ago)
- Topics: addon, ember, ember-data, json-api, serializer
- Language: JavaScript
- Homepage:
- Size: 129 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-json-serializer-meta
[](https://travis-ci.org/raido/ember-json-serializer-meta)
[](https://badge.fury.io/js/ember-json-serializer-meta)
So I heard you are working with custom APIs that are not either JSONAPI or REST but rather something in between, a hybrid. Then this addon is for you! It enables extracting metadata for all the Ember Data normalize*Response hooks.
```ember install ember-json-serializer-meta```
**Works with Ember 1.13+**
## How it works
### Flow chart
```
┌─ extractMetaFindAllResponse() ─────┐
├─ extractMetaFindHasManyResponse() ─┼─ extractMetaArrayResponse() ─────────────────────────────────┐
├─ extractMetaFindManyResponse() ────┤ │
├─ extractMetaQueryResponse() ───────┘ │
│ │
├─ extractMetaFindRecordResponse() ─────────────────────────────────┐ │
normalizeResponse() - normalizeMetaResponse() ─┼─ extractMetaFindBelongsToResponse() ──────────────────────────────┤ │
├─ extractMetaQueryRecordResponse() ────────────────────────────────┤ │
│ │ │
├─ extractMetaCreateRecordResponse() ─┐ │ │
├─ extractMetaDeleteRecordResponse() ─┼─ extractMetaSaveResponse() ─┴─ extractMetaSingleResponse() ─┴─ extractMetaResponse()
└─ extractMetaUpdateRecordResponse() ─┘
```
### API response
```
{
status: {
errorCode: 0
},
records: [{
id: 1,
name: 'Tomster'
}],
pagination: {
}
}
```
By default such payload is not supported by the JSONSerializer, it is impossible to extract metadata with default `extractMeta` hook.
Here comes in the addon which adds another serializer hook for extracting meta for your custom API responses with JSONSerializer.
```app/serializers/user.js
import extractMetaResponseMixin from 'ember-json-serializer-meta';
export default DS.JSONSerializer.extend(extractMetaResponseMixin, {
extractMetaResponse(store, typeClass, payload/*, id, requestType*/) {
if (payload && payload.pagination) {
return payload.pagination;
}
}
});
```
Default implementation of extractMetaResponse will lookup `meta` property.
```
{
...
meta: {
my: 'meta'
}
...
}
```
# Contribution
**This project follows [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).**
## Installation
* `git clone` this repository
* `yarn install`
## Running
* `ember serve`
* Visit your app at [http://localhost:4200](http://localhost:4200).
## Running Tests
* `yarn test` (Runs `ember try:each` to test your addon against multiple Ember versions)
* `ember test`
* `ember test --server`
## Building
* `ember build`
For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).