ash v1.36.0 Ash.Api.Dsl View Source
A small DSL for declaring APIs
Apis are the entrypoints for working with your resources.
Table of Contents
- resources
- resource
resources
List the resources present in this API
Examples:
resources do
resource MyApp.User
resource MyApp.Post
resource MyApp.Comment
end
resource
A reference to a resource
Introspection Target:
Examples:
resource MyApp.User
:as
- false A short name for the resource. Defaults to the last part of the module underscored, e.gSpecialThing
->:special_thing
.
Can be used in calls to Api modules, e.gApi.read(:special_thing)
and also customizes action helpers defined on the Api, e.gApi.special_thing_create(...)
:resource
- Required. The module of the resource