Package com.kazforge.jsonapi.api


@NullMarked package com.kazforge.jsonapi.api
Backend-independent Level-1 JSON:API application operations.

Level 1 coordinates the ordinary client/server-neutral operations that applications commonly need. Major-specific advanced APIs remain the explicit control surface for mapper configuration, Jackson-native type models, heterogeneous registry-backed envelopes, and direct codec, mapping, or binding composition. The Level-1 facade never guesses an ambiguous document shape or resource target.

The root JsonApi exposes four facets: JsonApiResources (resources, create/update authoring), JsonApiRelationships (relationship-linkage documents), JsonApiDocuments (raw/general documents), and JsonApiPatches (presence-aware PATCH). Values ResourceWriteOptions, ResourceDocument, and ResourceCollectionDocument carry neutral per-operation state and add no Jackson mechanics.

No type in this package imports or models backend implementation types. The facade adds no unified failure family: document-read, core validation, and mapping failures retain their focused contracts, and each adapter documents how its transport I/O failures cross the Level-1 boundary.

  • Class
    Description
    Backend-independent Level-1 JSON:API application entry point, currently implemented by the configured Jackson 3 runtime.
    Level-1 raw/general JSON:API document operations.
    Level-1 presence-aware PATCH operations.
    Level-1 relationship-linkage document operations in both directions.
    Backend-independent Level-1 ordinary resource operations: strict homogeneous reads, single/collection writes, and create/update document authoring.
    Level-1 typed read result for a resource collection plus selected document-level state.
    Level-1 typed read result for one resource plus selected document-level state.
    Backend-independent ordinary resource-write options composing existing neutral semantics.