Contents

# Vandal UI

This is a Rails engine for
[Graphiti](https://graphiti-api.github.io/graphiti/guides/) APIs. It has
two main functions:

* `rake vandal:install` will copy static files to `public/<api_namespace>`.
* Mounting the engine adds an endpoint for a dynamically-generated
  schema file:

```ruby
# config/routes.rb

scope path: ApplicationResource.endpoint_namespace, defaults: { format: :jsonapi } do
  # ... routes ...

  mount VandalUi::Engine, at: '/vandal'
end
```

If `ApplicationRecord.endpoint_namespace` is `/api/v1`, you'd get a
`/api/v1/vandal/schema.json` that would be referenced when loading the
UI.

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
vandal_ui-0.4.5	README.md
vandal_ui-0.4.4	README.md
vandal_ui-0.4.3	README.md
vandal_ui-0.4.2	README.md
vandal_ui-0.4.1	README.md
vandal_ui-0.4.0	README.md