Skip to content

Latest commit

 

History

History
123 lines (82 loc) · 3.67 KB

README.md

File metadata and controls

123 lines (82 loc) · 3.67 KB
Raw

SwaggerYard::Rails

TravisCI Gem Version

The SwaggerYard::Rails gem is a Rails Engine designed to parse your Yardocs API controllers using SwaggerYard. It'll create a Swagger-UI complaint JSON to be served out through where you mount SwaggerYard::Rails::Engine.

Installation

Add this line to your application's Gemfile:

gem 'swagger_yard-rails'

And then execute:

$ bundle

Usage

Mount your engine

# add to config/routes.rb
mount SwaggerYard::Rails::Engine, at: "/swagger"

Add JS/CSS for UI

In your Gemfile (until the release of 2.1.3):

gem 'swagger-ui_rails2', github: '3scale/swagger-ui_rails', branch: 'dev-2.1.3'

https://github.com/3scale/swagger-ui_rails/tree/dev-2.1.3#usage

in application.css:

*= require swagger-ui2/index

in application.js:

//= require swagger-ui2/index

Note: swagger_yard-rails will handle the template

Configure SwaggerYard

See Getting Started in the swagger_yard docs for details.

# config/initializers/swagger_yard.rb
SwaggerYard.configure do |config|
  # your configuration here
end

Write YARD documentation

Write YARD documentation for your controllers and models as described in SwaggerYard Usage.

To include a controller in your swagger definition, add a @resource tag to the controller's class documentation.

# @resource Pet
class PetsController < ApplicationController
  # ...
end

Once a controller has been tagged as a swagger resource, all public instance methods with docstrings will be candidates for inclusion as swagger apis, even if they don't include @path tags. swagger_yard-rails includes a path discovery function implementation that uses the Rails router to lookup paths, allowing @path tags to be omitted.

swagger_yard-rails also provides a @route tag to indicate a named route to be connected to an api action.

# config/routes.rb
Dummy::Application.routes.draw do
  get '/greet', to: 'hello#greeting', as: 'greeting'
end
# @resource Hello
class HelloController < ApplicationController
  # @route greeting
  def greeting
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/livingsocial/swagger_yard-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.