在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:olosegres/jsona开源软件地址:https://github.com/olosegres/jsona开源编程语言:TypeScript 100.0%开源软件介绍:JsonaJSON API v1.0 specification serializer and deserializer for use on the server and in the browser.
What problem does it solve?When you work with API standardized to json:api specification, you're dealing with a special and optimized JSON data format in the request and response body. You can get data of several entities that are related to each other, but you'll receive it in array (included). You may need to send modified back to server (or new data) in accordance with specification. This may puzzle you with the following questions:
Installation
or
How to useYou need to instantiate Jsona once, then use its public methods to convert data. import Jsona from 'jsona';
const dataFormatter = new Jsona(); deserialize - creates simplified object(s) from jsonconst json = {
data: {
type: 'town',
id: '123',
attributes: {
name: 'Barcelona'
},
relationships: {
country: {
data: {
type: 'country',
id: '32'
}
}
}
},
included: [{
type: 'country',
id: '32',
attributes: {
name: 'Spain'
}
}]
};
const town = dataFormatter.deserialize(json);
console.log(town); // will output:
/* {
type: 'town',
id: '123',
name: 'Barcelona',
country: {
type: 'country',
id: '32',
name: 'Spain'
},
relationshipNames: ['country']
} */ serialize - creates json from simplified object(s)const user = {
type: 'user',
id: 1,
categories: [{ type: 'category', id: '1', name: 'First category' }],
town: {
type: 'town',
id: '123',
name: 'Barcelona',
country: {
type: 'country',
id: '32',
name: 'Spain'
},
relationshipNames: ['country']
},
relationshipNames: ['categories', 'town']
};
const newJson = dataFormatter.serialize({
stuff: user, // can handle array
includeNames: ['categories', 'town.country'] // can include deep relations via dot
});
console.log(newJson); // will output:
/* {
data: {
type: 'user',
id: 1,
relationships: {
categories: {
data: [{ type: 'category', id: '1' }]
},
town: {
data: { type: 'town', id: '123' }
}
}
},
included: [{
type: 'category',
id: '1',
attributes: {
name: 'First category',
}
}, {
type: 'town',
id: '123',
attributes: {
name: 'Barcelona',
},
relationships: {
country: {
data: {
type: 'country',
id: '32',
}
}
}
}, {
type: 'country',
id: '32',
attributes: {
name: 'Spain',
}
}]
}*/ denormalizeReduxObject - creates simplified object(s) from reduxObject"reduxObject" - result object of json-api-normalizer const reduxObject = reduxStore.entities; // depends on where you store it
const town = dataFormatter.denormalizeReduxObject({reduxObject, entityType: 'town', entityIds: '123'});
console.log(town); // if there is such town and country in reduxObject, it will output:
/* {
type: 'town',
id: '123',
name: 'Barcelona',
country: {
type: 'country',
id: '34',
name: 'Spain'
},
relationshipNames: ['country']
} */ CustomizeBuild process and property namesYou can control process of building simplified objects, just use your own propertyMappers when Jsona instantiates. With IJsonPropertiesMapper you can implement your way of creation simplified objects (data models) from JSON, with IModelPropertiesMapper implement how to give back values from data model to JSON. It gives unlimited possibilities to integrate Jsona with react, redux, angular2 Example of passing your own propertyMappers to Jsona: import Jsona from 'jsona';
import {MyModelPropertiesMapper, MyJsonPropertiesMapper} from 'myPropertyMappers';
export const dataFormatter = new Jsona({
modelPropertiesMapper: MyModelPropertiesMapper,
jsonPropertiesMapper: MyJsonPropertiesMapper
}); Also, there is built-in switchCasePropertyMappers, that you can use if need to automatically transform property names from kebab, snake, camel case and back. CacheFor faster creation of simplified objects from json, it uses a cache for already processed json-entity, see DeserializeCache that uses by default. It possible to provide your own IDeserializeCache manager: import Jsona from 'jsona';
import {MyOwnDeserializeCache} from './index';
export const dataFormatter = new Jsona({
DeserializeCache: MyOwnDeserializeCache
}); LicenseJsona, examples provided in this repository and in the documentation are MIT licensed. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论