https://github.com/graphiti-api/vandal_ui
Ruby gem for installing Vandal
https://github.com/graphiti-api/vandal_ui
Last synced: 8 months ago
JSON representation
Ruby gem for installing Vandal
- Host: GitHub
- URL: https://github.com/graphiti-api/vandal_ui
- Owner: graphiti-api
- License: mit
- Created: 2019-01-06T16:59:01.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T19:54:21.000Z (9 months ago)
- Last Synced: 2025-03-23T19:44:05.188Z (9 months ago)
- Language: Ruby
- Size: 1020 KB
- Stars: 9
- Watchers: 3
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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/`.
* 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.