[Pitchburgh] JSON API

Meta issue to track tasks related to the Pitch-burgh initiative.

Pitch-burgh Commitment Overview

Our goal is to assemble a group of contributors in order to combine the best of existing Drupal API clients into a set of utilities that can both address common use cases with little configuration, and also be extended to support the needs of a diverse JavaScript ecosystem.

The team will contribute a ‘Drupal API Client’ general project on Drupal.org which will offer:

• A base API client package that contains all common elements shared by different API implementations. This class will be extended by individual API clients and provides defaults for things like data fetching and caching that can be easily overridden.
  A JS
• A JSON:API client package. Extends the base API client to provide a client for Drupal’s JSON:API implementation. Can also be extended to override defaults. Initially this will be the primary client implementation.

These packages will be both framework-agnostic and universal so that they can be used with any JavaScript framework, server or client-side rendered.

This approach will result in ready-made clients for common Drupal APIs that can be installed via npm. It will also provide a base for customization to meet specific requirements or take advantage of framework specific features.

Child Issues

Project Kickoff:
* scope of work
* project plan
* list of deliverables
* signed agreement

Implementation
* JSON:API Client 'Vertical Slice' POC
* JSON:API Client 1.0 (Complete)
* Scaffold GraphQL Package(In review)

Documentation and Distribution
* Proposal for Drupal JavaScript Maintainers
* Project Documentation
* API Documentation
* Publishing - Initial 0.1 POC and 1.x published on NPM!

Current Status (as of April 2024)

* We consider our scope for Pitchburgh complete. Thanks to all who helped along the way!

Current Status (as of November 1)

* JSON:API Client 'Vertical Slice' POC is complete.
* POC published as 0.1.0 on NPM
* Current API Documentation Published.
* Project Documentation in progress.

Status (as of October 15)

JSON:API Client 'Vertical Slice' POC is functionally complete and we're preparing to publish the first release of the POC. Join us in #api-client on Drupal Slack :)