Skip to content

byrgenwerth-freshman/api-url-generator

Repository files navigation

API URL Generator

After writing a few RESTful APIs with Rails, I was always running into issues with generating URL for my resources. Either, I would try to force url_for or path_to to work, but it was never ideal. Since, I couldn't find anyother solutions, I decide to write my own. This gem helps create urls for your RESTful API to make it easier for client applications to navigate without using ActionView::Helpers

Installation

Add this line to your application's Gemfile:

gem 'api_url_generator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install api_url_generator

Usage

If you want to include the domain declare

APIURLGenerator.url("0.0.0.0:5000")

To call a single resource

APIURLGenerator.generate_url(object)

To make a nested resource

APIURLGenerator.generate_url(object, "project")

The secound

Contributing

  1. Fork it ( https://github.com/matao/api-url-generator/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages