pipeline status Gem Version


Azahara schema helps you to work with your model view. Its basic usage is for your index method. But can be used even as a master-detail component.

  • It defines filters for you.
  • It renders json responses for you
  • Defines easy api over you model
  • Lets you define your own outputs and manages them for you.


Add this line to your application's Gemfile:

gem 'azahara_schema'

And then execute:

$ bundle

Or install it yourself as:

$ gem install azahara_schema


Detailed developers documentation can be found at Documentation.

Default usage is only for Rails.

You basically need just this:

@schema = AzaharaSchema::Schema.new(Model)

But you can ovewrite the default behaviour. Just inherit from AzaharaSchema::ModelSchema

class UserSchema < AzaharaSchema::ModelSchema


Azahara takes the name of model before Schema and uses it for looking for model class. Alternatively you can overwrite method model and let it return class for your model.

Defining enabled/disabled filters

In your inherited class you can globally set enabled filter - for azahara not to populate unwanted parameters of your model.

self.enabled_filters 'attr_name1', 'attr_name2'

Second option is defining those on instance - it is preferable solution and is more straight forward. Here you can even solve the permissions.

def enabled_filters
  filters = ['attr_name1', 'attr_name2']
  filters << 'attr_name3' if User.current.admin?

Alternative for it is just black list attributes you do not want to have as filters.

def disabled_filters
  to_disable = []
  to_disable << ['attr_name3'] if !User.current.admin?

Or you can use all those methods together.


Contribution directions go here.


The gem is available as open source under the terms of the EUPL License in version 1.2.