0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A Raid schema generator for Insomnia.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
>= 0
 Project Readme

Welcome

This will provide an Insomnia compatible schema for a Apia API. It's a bit rough and ready at the moment and was put together quite quickly but it should generate what is needed of it. There are no tests.

You'll need to have your Apia API running. Once it's up and running, you can add this library.

Installation

Start by adding the gem to your Gemfile.

gem 'apia-insomnia', '~> 1.0'

Once you've done this, you'll need to just mount it up.

module MyApp
  class Application < Rails::Application

    # ... other configuration for your application will also be in this file.

    config.middleware.use Apia::Insomnia::Rack, 'CoreAPI::Base', '/api/core/v1/schema/insomnia',
      development: Rails.env.development?,
      base_url: "https://api.yourapp.com/v1"

  end
end

Usage

You can then just access the appropriate URL above to download the schema. The URL can be pasted into