> For the complete documentation index, see [llms.txt](https://docs.opensoutheners.com/oss/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opensoutheners.com/oss/laravel-apiable/readme.md).

# Introduction

A Laravel package that integrates JSON:API resources into your API projects with filtering, sorting, includes, pagination, and more.

**Laravel Apiable** brings the [JSON:API specification](https://jsonapi.org/) to your Laravel application. It builds on top of Laravel's existing API resources, Eloquent query builder, and request handling -- so you keep using the tools you already know.

## Features

* **JSON:API serialization** -- Transform models and collections into spec-compliant responses
* **Filtering** -- 7 filter operators including LIKE, exact match, comparison operators, and query scopes
* **Sorting** -- Sort by attributes or relationships with automatic JOIN handling
* **Includes** -- Eager-load and embed related resources as compound documents
* **Sparse fieldsets** -- Let clients select only the fields they need
* **Appends** -- Expose computed model accessors on demand
* **Full-text search** -- Laravel Scout integration with search filters
* **Pagination** -- Length-aware, simple, or cursor-based strategies with FastPaginate support
* **Content negotiation** -- Automatic format switching based on Accept headers
* **Error handling** -- Render exceptions in JSON:API error format
* **Testing utilities** -- Fluent assertion helpers for JSON:API responses
* **Documentation generator** -- Export Postman, Markdown, and OpenAPI docs from controller attributes

## Requirements

* PHP 8.2+
* Laravel 12+

## Quick start

```bash
composer require open-southeners/laravel-apiable
```

Then head to the [Installation](/oss/laravel-apiable/getting-started/installation.md) guide to set up your models and configuration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.opensoutheners.com/oss/laravel-apiable/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.