spree-resource

Adding a Spree Resource

Commands below use the Spree CLI form (spree …, Docker). On a classic Rails app without the CLI (typical pre-5.4), use the native mapping in the spree-project skill — bin/rails / bundle exec rake from the app root, paths without the backend/ prefix.

To add a new model that's exposed via the Spree v3 API, use the spree:api_resource generator. One command produces:

• The model (in backend/app/models/spree/<name>.rb)
• The migration
• Store + Admin API controllers
• Store + Admin serializers
• FactoryBot factory
• Controller specs covering full CRUD
• Routes (injected into spree/api/config/routes.rb)

Prerequisite: run spree eject first — the generator executes inside the Docker container, and only the ejected dev compose bind-mounts ./backend, so generated files appear (and persist) on your host.

The one-command path

spree generate api_resource Brand name:string:uniq active:boolean --writable

Field syntax follows Rails' attribute parser, with Spree extensions:

Modifier	Effect
:string, :integer, :boolean, :decimal, :date, :datetime, :text	Column type
:uniq	Unique index on the column + uniqueness validation scoped to spree_base_uniqueness_scope
:index	Non-unique index
<name>:belongs_to (or <name>:references)	belongs_to :<name> association with index, no FK constraint. Class auto-resolved from the name (brand → Spree::Brand, user → Spree.user_class, admin_user/created_by/approver/canceler → Spree.admin_user_class); override with an unqualified class hint in braces: category:belongs_to{TaxonCategory}

Example field specs:

name:string:uniq               # unique non-null string with index + validator
description:text               # non-null text column
active:boolean                 # non-null boolean
price:decimal                  # non-null decimal
brand:belongs_to               # association to Spree::Brand (class auto-resolved from the attribute name; use brand:belongs_to{OtherClass} for an explicit, unqualified class hint)