![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-black-text.png?raw=true#gh-light-mode-only)
![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-white-text.png?raw=true#gh-dark-mode-only)

![Elixir CI](https://github.com/ash-project/ash_json_api/workflows/CI/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Hex version badge](https://img.shields.io/hexpm/v/ash_json_api.svg)](https://hex.pm/packages/ash_json_api)
[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_json_api)

# AshJsonApi

Welcome! This is the extension for building [JSON:API](https://jsonapi.org) spec compliant APIs with [Ash](https://hexdocs.pm/ash). Generate a powerful JSON API in minutes!

## Tutorials

- [Getting Started with AshJsonApi](documentation/tutorials/getting-started-with-ash-json-api.md)

## Topics

- [What is AshJsonApi?](documentation/topics/what-is-ash-json-api.md)
- [Non-Spec Query Parameters](documentation/topics/non-spec-query-parameters.md)
- [OpenAPI](documentation/topics/open-api.md)
- [Relationships](documentation/topics/relationships.md)
- [Authorize With AshJsonApi](documentation/topics/authorize-with-json-api.md)
- [Upgrading to 1.0](documentation/topics/upgrade.md)

## Reference

- [AshJsonApi.Resource DSL](documentation/dsls/DSL-AshJsonApi.Resource.md)
- [AshJsonApi.Domain DSL](documentation/dsls/DSL-AshJsonApi.Domain.md)