Package com.kazforge.jsonapi.api

Interface JsonApi

public interface JsonApi
Backend-independent Level-1 JSON:API application entry point, currently implemented by the configured Jackson 3 runtime.

Level 1 coordinates ordinary client and server operations: strict resource reads, single/collection writes, create/update authoring, linkage documents, raw documents with explicit context, and presence-aware PATCH. Major-specific advanced APIs remain available for Jackson type models, heterogeneous envelopes, runtime construction, and direct codec, mapper, or binder control.

The contract is bidirectional and does not encode HTTP transport, persistence, authorization, or controller policy. Application-lifetime Jackson and representation configuration belongs to the major-specific runtime; this interface exposes cohesive per-operation facets only. Property semantics are currently derived through caller-configured Jackson.

  • Method Details

    • resources

      JsonApiResources resources()
      Ordinary resource reads, writes, and create/update authoring.

    • relationships

      JsonApiRelationships relationships()
      Relationship-linkage document reads and writes.

    • documents

      JsonApiDocuments documents()
      Raw/general document operations with explicit semantic context.

    • patches

      JsonApiPatches patches()
      Presence-aware PATCH binding: typed DTOs and low-level commands.