Skip to content

Introduction

The @triptyk/nfw-jsonapi contains a builder that setups jsonapi endpoints and resources.

Installation

Info

This module depends of : @triptyk/nfw-core, @triptyk/nfw-http, @triptyk/nfw-mikro-orm.

pnpm install @triptyk/nfw-jsonapi

Danger

This module is experimental and subject to drastical changes

What it does

The final goal of this addon is to:

  • Be agnostic of the database.
  • Make it easier to parse and validate request body/query to a convenient format.
  • Easier routing and creation of jsonapi routes for a given resource.
  • Easily describe the behavior, relationships and attributes of a resource.
  • Support of JSONAPI version 1.0.

Schema

alt text