<commit_before>swagger-rails
=========

Leverage your api/integration test specs to generate [swagger](http://swagger.io/) descriptions for Rails-based API's. Use the provided DSL to accurately test and describe API operations in your spec files. Then, you can easily generate corresponding swagger.json files and serve them up with an embedded version of [swagger-ui](https://github.com/swagger-api/swagger-ui). This means you can complement your API with a slick discovery UI to assist consumers with their integration efforts. Best of all, it requires minimal coding and maintenance, allowing you to focus on building an awesome API!

And that's not all ...

Once you have a Web API that can describe itself in Swagger, you've opened the treasure chest of Swagger-based tools including a client generator that can be targeted to a wide range of popular platforms. See [swagger-codegen](https://github.com/swagger-api/swagger-codegen) for more details.

__NOTE__: It's early days so please be gentle when reporting issues :) As author of a similar project in the .NET space - [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle), that's become very popular, I think there's real potential here. Please feel free to contribute. I'll be more than happy to consider PR's ... so long as they include tests.

## Getting Started ##

1. Add this line to your applications _Gemfile_:

    ```ruby
    gem swagger_rails
    ```

2. Run the install generator

    ```ruby
    rails g swagger_rails:install
    ```

3. Create an integration spec to describe and test your API

    ```ruby
    require 'rails_helper'
    require 'swagger_rails/rspec/adapter'

    describe 'Blogs API' do
      extend SwaggerRails::RSpec::Adapter 

      path '/blogs' do

        post 'creates a new blog' do
          consumes 'application/json'
          parameter :blog, in: :body, schema: {
            type: :object,
            properties: {
              title: { :type => :string },
              content: { :type => :string }
            },
            required: [ 'title', 'content' ]
          }

          response '200', 'success' do
            let(:blog) { { title: 'foo', content: 'bar' } }
            run_test!
          end

          response '422', 'invalid request' do
            let(:blog) { { title: 'foo' } }
            run_test!
          end
        end
      end
    end
    ```

4. Generate the swagger.json file(s)

    ```ruby
    rake swaggerize
    ```

5. Spin up your app and check out the awesome, auto-generated docs at _/api-docs_!

## How does it Work? ##

There's two separate parts to swagger rails:

1. Tooling to easily generate swagger descriptions directly from your API tests/specs  
2. Rails middleware to auto-magically serve a swagger-ui that's powered by those descriptions

The tooling is designed to fit seamlessly into your development workflow, with the swagger docs and UI being a by-product that you get for free ... well almost free :) You'll need to use the provided rspec DSL, but it's an intuitive syntax (based on the swagger-spec) and, IMO, a very succint and expressive way to write api/integration tests.

Once you've generated the swagger files, the functionality to serve up them up, along with the swagger-ui, is provided as a Rails Engine. After running the install generator, you'll see the following line added to _routes.rb_

  ```ruby
  mount SwaggerRails::Engine => '/api-docs'
  ```
  
This will wire up routes for the swagger docs and swagger-ui assets, all prefixed with "/api-docs". For example, if you navigate to "/api-docs/index.html" you'll get the swagger-ui. If you navigate to "/api-docs/v1/swagger.json", you'll get the swagger.json file under your app root at "config/swagger/v1/swagger.json" - assuming it was generated.

If you'd like your swagger resources to appear under a different base path, you can change the Engine mount point from "/api-docs" to something else.

By default, the generator will create all operation descriptions in a single swagger.json file. You can customize this by defining additional documents in the swagger_rails initializer (also created by the install generator) ...

  ```ruby
  SwaggerRails.configure do |c|

    c.swagger_doc 'v1/swagger.json' do
      {
        info: { title: 'API V1', version: 'v1' }
      }
    end

    c.swagger_doc 'v2/swagger.json' do
      {
        info: { title: 'API V2', version: 'v2' }
      }
    end
  end
  ```

And then tagging your spec's with the target swagger_doc:

    ```ruby
    require 'rails_helper'
    require 'swagger_rails/rspec/adapter'

    describe 'Blogs API V2', swagger_doc: 'v2/swagger.json' do
      extend SwaggerRails::RSpec::Adapter 

      path '/blogs' do
        ...
      end
    end
    ```

Then, when you run the generator and spin up the swagger-ui, you'll see a select box in the top right allowing your audience to switch between the different API versions.

## Customizing the UI ##

The swagger-ui provides several options for customizing it's behavior, all of which are documented here https://github.com/swagger-api/swagger-ui#swaggerui. If you need to tweak these or customize the overall look and feel of your swagger-ui, then you'll need to provide your own version of index.html. You can do this with the following generator.

```ruby
rails g swagger_rails:custom_ui
```

This will add a local version that you can customize at "app/views/swagger_rails/swagger_ui/index.html.erb"<commit_msg>More readme typo fixes<commit_after>swagger-rails
=========

Leverage your api/integration test specs to generate [swagger](http://swagger.io/) descriptions for Rails-based API's. Use the provided DSL to accurately test and describe API operations in your spec files. Then, you can easily generate corresponding swagger.json files and serve them up with an embedded version of [swagger-ui](https://github.com/swagger-api/swagger-ui). This means you can complement your API with a slick discovery UI to assist consumers with their integration efforts. Best of all, it requires minimal coding and maintenance, allowing you to focus on building an awesome API!

And that's not all ...

Once you have a Web API that can describe itself in Swagger, you've opened the treasure chest of Swagger-based tools including a client generator that can be targeted to a wide range of popular platforms. See [swagger-codegen](https://github.com/swagger-api/swagger-codegen) for more details.

__NOTE__: It's early days so please be gentle when reporting issues :) As author of a similar project in the .NET space - [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle), that's become very popular, I think there's real potential here. Please feel free to contribute. I'll be more than happy to consider PR's ... so long as they include tests.

## Getting Started ##

1. Add this line to your applications _Gemfile_:

    ```ruby
    gem swagger_rails
    ```

2. Run the install generator

    ```ruby
    rails g swagger_rails:install
    ```

3. Create an integration spec to describe and test your API

    ```ruby
    require 'rails_helper'
    require 'swagger_rails/rspec/adapter'

    describe 'Blogs API' do
      extend SwaggerRails::RSpec::Adapter 

      path '/blogs' do

        post 'creates a new blog' do
          consumes 'application/json'
          parameter :blog, in: :body, schema: {
            type: :object,
            properties: {
              title: { :type => :string },
              content: { :type => :string }
            },
            required: [ 'title', 'content' ]
          }

          response '200', 'success' do
            let(:blog) { { title: 'foo', content: 'bar' } }
            run_test!
          end

          response '422', 'invalid request' do
            let(:blog) { { title: 'foo' } }
            run_test!
          end
        end
      end
    end
    ```

4. Generate the swagger.json file(s)

    ```ruby
    rake swaggerize
    ```

5. Spin up your app and check out the awesome, auto-generated docs at _/api-docs_!

## How does it Work? ##

There's two separate parts to swagger rails:

1. Tooling to easily generate swagger descriptions directly from your API tests/specs  
2. Rails middleware to auto-magically serve a swagger-ui that's powered by those descriptions

The tooling is designed to fit seamlessly into your development workflow, with the swagger docs and UI being a by-product that you get for free ... well almost free :) You'll need to use the provided rspec DSL. But, it's an intuitive syntax (based on the [swagger-spec](http://swagger.io/specification/)) and, IMO, a very succint and expressive way to write api/integration tests.

Once you've generated the swagger files, the functionality to serve them up, along with the swagger-ui, is provided as a Rails Engine. After running the install generator, you'll see the following line added to _routes.rb_

  ```ruby
  mount SwaggerRails::Engine => '/api-docs'
  ```
  
This will wire up routes for the swagger docs and swagger-ui assets, all prefixed with "/api-docs". For example, if you navigate to "/api-docs/index.html" you'll get the swagger-ui. If you navigate to "/api-docs/v1/swagger.json", you'll get the swagger.json file under your app root at "config/swagger/v1/swagger.json" - assuming it was generated.

If you'd like your swagger resources to appear under a different base path, you can change the Engine mount point from "/api-docs" to something else.

By default, the generator will create all operation descriptions in a single swagger.json file. You can customize this by defining additional documents in the swagger_rails initializer (also created by the install generator) ...

  ```ruby
  SwaggerRails.configure do |c|

    c.swagger_doc 'v1/swagger.json' do
      {
        info: { title: 'API V1', version: 'v1' }
      }
    end

    c.swagger_doc 'v2/swagger.json' do
      {
        info: { title: 'API V2', version: 'v2' }
      }
    end
  end
  ```

And then tagging your spec's with the target swagger_doc:

  ```ruby
  require 'rails_helper'
  require 'swagger_rails/rspec/adapter'

  describe 'Blogs API V2', swagger_doc: 'v2/swagger.json' do
    extend SwaggerRails::RSpec::Adapter 

    path '/blogs' do
      ...
    end
  end
  ```

Then, when you run the generator and spin up the swagger-ui, you'll see a select box in the top right allowing your audience to switch between the different API versions.

## Customizing the UI ##

The swagger-ui provides several options for customizing it's behavior, all of which are documented here https://github.com/swagger-api/swagger-ui#swaggerui. If you need to tweak these or customize the overall look and feel of your swagger-ui, then you'll need to provide your own version of index.html. You can do this with the following generator.

```ruby
rails g swagger_rails:custom_ui
```

This will add a local version that you can customize at "app/views/swagger_rails/swagger_ui/index.html.erb"
{'fraction_non_alphanumeric': 0.08388742144093268, 'fraction_numerical': 0.00418981692321705, 'mean_word_length': 3.132480240873165, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2415177', 'n_tokens_mistral': 3161, 'n_tokens_neox': 2973, 'n_words': 1371}