Contents¶

Preface¶

• Introduction
• Installation
  • Loading Crud
• Setup
  • Application
  • Controller
  • Exception Handler
  • Routing
  • Request detector

Listener Configuration¶

• Listener Options
  • withJsonApiVersion
  • meta
  • absoluteLinks
  • debugPrettyPrint
  • jsonOptions
  • include
  • fieldSets
  • docValidatorAboutLinks
  • queryParameters
• Debugging
• Pagination
• Schemas
  • Custom entity schema
  • Custom dynamic schema

API Usage¶

• Fetching Collections
• Fetching Resources
• Creating Resources
  • Request Data
  • Side-Posting
• Updating Resources
  • Updating To-One Relationships
  • Updating To-Many Relationships
• Deleting Resources
• Errors and Exceptions
  • Default Errors
  • Validation Errors
  • Invalid Request Data

Advanced API Usage¶

• Inclusion
  • Associated Data
  • Include Parameter
  • allowList/denyList
• Sparse Fieldsets
  • Limiting Associated Data
  • Combinations
• Sorting
  • Single Field Sorting
  • Multi Field Sorting
  • Sorting By Related Data
  • Combined Sorts
• Filtering

Additional Information¶

• JSON Examples
• Common Issues
  • Missing template
  • Missing routes
  • Schema not registered
  • Normal HTML is returned
• Customizing Output
  • Date Formats
• Contributing