README.md

JSON:API Library

A TypeScript implementation of the JSON:API specification. This monorepo contains the following packages:

• @vmelou/jsonapi - Core library for serializing and deserializing JSON:API data
• @vmelou/jsonapi-angular - Angular integration with HttpClient and RxJS support

Features

Core Library (@vmelou/jsonapi)

• Serialize TypeScript classes to JSON:API compliant objects
• Deserialize JSON:API responses into TypeScript class instances
• Support for relationships and included resources
• Handles primitive types and Date objects
• Support for collection responses with pagination
• Error handling with JSON:API error objects

Angular Integration (@vmelou/jsonapi-angular)

• Complete integration with Angular's HttpClient
• RxJS Observables for all API operations
• Support for CRUD operations (Create, Read, Update, Delete)
• List operations with pagination and filtering
• Error handling with JSON:API error objects
• TypeScript type safety

Quick Start

Core Library

npm install @vmelou/jsonapi

Angular Integration

npm install @vmelou/jsonapi @vmelou/jsonapi-angular

Documentation

• Core Library Documentation
• Angular Integration Documentation

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details on how to get involved.

Changelog

Detailed changes for each release are documented in the CHANGELOG.md file.

License

MIT