This is an in-progress list of resources to support my talk about JSON:API at Laracon Online 2020.

Instructions on implementing JSON:API

• How to implement JSON:API using Eloquent Resources
• How to implement JSON:API using Fractal
• How to implement JSON:API using Laravel-JSON-API

What you get from each option

Links

• Introduction to JSON:API

  • JSON:API spec
  • HowToJsonApi.com
  • An Introduction to the JSON:API Specification (talk slides from Dan Gebhardt, co-editor of JSON:API)
  • Pragmatic JSON API Design (talk video from Jeremiah Lee, who implemented JSON:API at Fitbit)
  • “JSON API: convention driven API design”, by Steve Klabnik APIdays Paris 2013 - old, not for syntax but for reasoning
  • Making the Most of JSON:API

• Related API and JSON:API topics

  • API Caching done right
  • GraphQL & Caching: The Elephant in the Room
  • Representing State in REST and GraphQL
  • REST APIs must be hypertext-driven
  • Designing a True REST State Machine
  • Let’s stop building APIs around a network hack

Big required pieces of JSON:API APIs

• Content Negotiation & appropriate status codes
• Top level data/errors/meta
• Resource Identifier Objects: string "id" and string "type"
• Other properties stored in "attributes" object on resource
• If showing relationships, stored in "relationships" object on resource
• If storing meta, stored in "meta" object with key/value pairs
• (optional) "links" object with related URLs
• (optional) Compound documents' resources in flat "included" array
• Specific error format
• Specific resource naming format (a-zA-Z_-)
• Specifications around requesting mutations (full CRUD specified)

Goals

• Clean all of these pages up into full tutorials
• Show a real proof of flat includes with Eloquent Resources
• Find simple solutions for the items that Eloquent Resources and Fractal don't have, if anyone would prefer not using Laravel-JSON-API