Full Example
A complete end-to-end example with types, contracts, routing, controllers, and frontend
Full Example
This example builds an order management API from scratch — types, contracts, routing, controller, and frontend client.
1. Types
Zodra.scalar :money, base: :decimal do |value|
BigDecimal(value.to_s).round(2)
rescue ArgumentError
:coercion_error
endZodra.enum :order_status, values: %i[draft confirmed shipped delivered cancelled]Zodra.type :product do
uuid :id
string :name
string :sku
money :price
integer :stock
boolean :published
endZodra.type :line_item do
uuid :id
reference :product
integer :quantity, min: 1
money :unit_price
money :total_price
endZodra.type :customer do
uuid :id
string :name
string :email
string? :phone
string :notes, nullable: true
datetime :registered_at
timestamps
endZodra.type :order do
uuid :id
string :number
order_status :status
reference :customer
array :line_items, of: :line_item
money :total_amount
string? :shipping_address
date :estimated_delivery, nullable: true
timestamps
endZodra.type :order_input do
uuid :customer_id
string? :shipping_address
array :items, of: :order_item_input
endZodra.type :order_item_input do
uuid :product_id
integer :quantity, min: 1
end2. Contract
Zodra.contract :orders do
action :index do
response :order, collection: true
end
action :show do
params do
uuid :id
end
response :order
end
action :create do
params from: :order_input
response :order
error :validation_failed, status: 422
errors do
key :base
key :customer_id
key :shipping_address
key :items do
key :product_id
key :quantity
end
end
end
action :confirm do
params do
uuid :id
end
response :order
error :not_found, status: 404
error :invalid_transition, status: 422
end
action :cancel do
params do
uuid :id
end
response :order
error :not_found, status: 404
error :invalid_transition, status: 422
end
action :search do
params do
order_status? :status
date? :from_date
date? :to_date
end
response :order, collection: true
end
end3. API routes
Zodra.api "/api/v1" do
resources :orders, only: %i[index show create] do
member do
patch :confirm
patch :cancel
end
collection do
get :search
end
end
endRails.application.routes.draw do
mount Zodra::Swagger => '/docs'
zodra_routes
end4. ErrorMapper
class OrderErrorMapper < Zodra::ErrorMapper
def call(order:)
collect(order) do
ignore :number, :status, :total_amount
map_remaining
end
item_errors = build_item_errors(order.line_items)
result[:items] = item_errors if item_errors.any?
result
end
private
def build_item_errors(line_items)
line_items.filter_map do |line_item|
next if line_item.errors.empty?
mapped = {}
line_item.errors.to_hash.each do |key, messages|
next if %i[order unit_price total_price].include?(key)
mapped_key = key == :product ? :product_id : key
mapped[mapped_key] = messages
end
mapped.presence
end
end
end5. Controller
module Api
module V1
class OrdersController < ApplicationController
include Zodra::Controller
zodra_rescue :confirm, InvalidTransitionError, as: :invalid_transition
zodra_rescue :cancel, InvalidTransitionError, as: :invalid_transition
def index
orders = Order.includes(:customer, line_items: :product).all
zodra_respond_collection(orders)
end
def show
order = Order.includes(:customer, line_items: :product)
.find(zodra_params[:id])
zodra_respond(order)
end
def create
order = build_order_record
if order.valid? && order.line_items.all?(&:valid?)
ActiveRecord::Base.transaction do
order.save!
order.recalculate_total!
end
zodra_respond(order.reload, status: :created)
else
zodra_errors(OrderErrorMapper.call(order: order))
end
end
def confirm
order = Order.find(zodra_params[:id])
order.confirm!
zodra_respond(order.reload)
end
def cancel
order = Order.find(zodra_params[:id])
order.cancel!
zodra_respond(order.reload)
end
def search
orders = Order.includes(:customer, line_items: :product)
orders = orders.where(status: zodra_params[:status]) if zodra_params[:status]
orders = orders.where("created_at >= ?", zodra_params[:from_date]) if zodra_params[:from_date]
orders = orders.where("created_at <= ?", zodra_params[:to_date]) if zodra_params[:to_date]
zodra_respond_collection(orders)
end
private
def build_order_record
order = Order.new(
customer_id: zodra_params[:customer_id],
shipping_address: zodra_params[:shipping_address],
total_amount: 0,
)
zodra_params[:items].each do |item|
product = Product.find_by(id: item[:product_id])
order.line_items.build(
product: product,
quantity: item[:quantity],
unit_price: product&.price || 0,
)
end
order
end
end
end
end6. Generate TypeScript
rails zodra:export7. Frontend client
import { createApiClient } from "@zodra/client";
import { contracts } from "./zodra";
export const api = createApiClient({
baseUrl: "/api/v1",
contracts,
validateParams: true,
});import {
ZodraFieldError,
ZodraBusinessError,
} from "@zodra/client";
import { api } from "./api";
// List orders
const { data: orders } = await api.orders.index({});
// Search by status
const { data: confirmed } = await api.orders.search({
status: "confirmed",
from_date: "2024-01-01",
});
// Create an order
try {
const { data: order } = await api.orders.create({
customer_id: "550e8400-e29b-41d4-a716-446655440000",
shipping_address: "123 Main St",
items: [
{ product_id: "...", quantity: 2 },
{ product_id: "...", quantity: 1 },
],
});
console.log("Created order:", order.number);
} catch (error) {
if (error instanceof ZodraFieldError) {
console.log("Validation errors:", error.errors);
}
}
// Confirm an order
try {
const { data: order } = await api.orders.confirm({ id: "..." });
console.log("Order confirmed:", order.status);
} catch (error) {
if (error instanceof ZodraBusinessError) {
console.log("Cannot confirm:", error.message);
}
}