Example API Description
" config.request_headers_to_include = %w[Cookie] config.response_headers_to_include = %w[Content-Type] end @@ -66,6 +67,12 @@ Feature: Generate HTML documentation from test examples | Greetings | And I should see the api name "Example API" + Scenario: Create an index with proper description + When I open the index + Then I should see the following resources: + | Greetings | + And I should see the api explanation "Example API Description" + Scenario: Example HTML documentation includes the parameters When I open the index And I navigate to "Greeting your favorite gem" diff --git a/features/json_iodocs.feature b/features/json_iodocs.feature index 319855db..e6d7ac37 100644 --- a/features/json_iodocs.feature +++ b/features/json_iodocs.feature @@ -24,6 +24,7 @@ Feature: Json Iodocs RspecApiDocumentation.configure do |config| config.app = App config.api_name = "app" + config.api_explanation = "desc" config.format = :json_iodocs config.io_docs_protocol = "https" end @@ -70,6 +71,7 @@ Feature: Json Iodocs { "app" : { "name" : "app", + "description": "desc", "protocol" : "https", "publicPath" : "", "baseURL" : null diff --git a/features/markdown_documentation.feature b/features/markdown_documentation.feature index 1e461a78..a6cf4957 100644 --- a/features/markdown_documentation.feature +++ b/features/markdown_documentation.feature @@ -49,6 +49,7 @@ Feature: Generate Markdown documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Example API Description" config.format = :markdown config.request_headers_to_include = %w[Content-Type Host] config.response_headers_to_include = %w[Content-Type Content-Length] @@ -148,6 +149,7 @@ Feature: Generate Markdown documentation from test examples Then the file "doc/api/index.markdown" should contain exactly: """ # Example API + Example API Description ## Help diff --git a/features/slate_documentation.feature b/features/slate_documentation.feature index 86e1c5fb..0a3531b0 100644 --- a/features/slate_documentation.feature +++ b/features/slate_documentation.feature @@ -49,6 +49,7 @@ Feature: Generate Slate documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Description" config.format = :slate config.curl_host = 'http://localhost:3000' config.request_headers_to_include = %w[Content-Type Host] diff --git a/features/textile_documentation.feature b/features/textile_documentation.feature index 0cbaa03d..dae338c8 100644 --- a/features/textile_documentation.feature +++ b/features/textile_documentation.feature @@ -49,6 +49,7 @@ Feature: Generate Textile documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Example API Description" config.format = :textile config.request_headers_to_include = %w[Content-Type Host] config.response_headers_to_include = %w[Content-Type Content-Length] @@ -148,6 +149,7 @@ Feature: Generate Textile documentation from test examples Then the file "doc/api/index.textile" should contain exactly: """ h1. Example API + Example API Description h2. Help diff --git a/lib/rspec_api_documentation/configuration.rb b/lib/rspec_api_documentation/configuration.rb index 6c461bc3..edb46e69 100644 --- a/lib/rspec_api_documentation/configuration.rb +++ b/lib/rspec_api_documentation/configuration.rb @@ -75,6 +75,7 @@ def self.add_setting(name, opts = {}) add_setting :curl_host, :default => nil add_setting :keep_source_order, :default => false add_setting :api_name, :default => "API Documentation" + add_setting :api_explanation, :default => nil add_setting :io_docs_protocol, :default => "http" add_setting :request_headers_to_include, :default => nil add_setting :response_headers_to_include, :default => nil diff --git a/lib/rspec_api_documentation/views/markup_index.rb b/lib/rspec_api_documentation/views/markup_index.rb index bbb27f89..93ab4af1 100644 --- a/lib/rspec_api_documentation/views/markup_index.rb +++ b/lib/rspec_api_documentation/views/markup_index.rb @@ -3,16 +3,14 @@ module RspecApiDocumentation module Views class MarkupIndex < Mustache + delegate :api_name, :api_explanation, to: :@configuration, prefix: false + def initialize(index, configuration) @index = index @configuration = configuration self.template_path = configuration.template_path end - def api_name - @configuration.api_name - end - def sections RspecApiDocumentation::Writers::IndexHelper.sections(examples, @configuration) end diff --git a/lib/rspec_api_documentation/writers/json_iodocs_writer.rb b/lib/rspec_api_documentation/writers/json_iodocs_writer.rb index 25235d85..fd2f5c1d 100644 --- a/lib/rspec_api_documentation/writers/json_iodocs_writer.rb +++ b/lib/rspec_api_documentation/writers/json_iodocs_writer.rb @@ -94,6 +94,7 @@ def as_json(opts = nil) { @api_key.to_sym => { :name => @configuration.api_name, + :description => @configuration.api_explanation, :protocol => @configuration.io_docs_protocol, :publicPath => "", :baseURL => @configuration.curl_host diff --git a/spec/configuration_spec.rb b/spec/configuration_spec.rb index 23046d63..14ffc7fd 100644 --- a/spec/configuration_spec.rb +++ b/spec/configuration_spec.rb @@ -52,6 +52,7 @@ its(:curl_host) { should be_nil } its(:keep_source_order) { should be_falsey } its(:api_name) { should == "API Documentation" } + its(:api_explanation) { should be_nil } its(:client_method) { should == :client } its(:io_docs_protocol) { should == "http" } its(:request_headers_to_include) { should be_nil } diff --git a/templates/rspec_api_documentation/html_index.mustache b/templates/rspec_api_documentation/html_index.mustache index 76a338f5..bbe78ebd 100644 --- a/templates/rspec_api_documentation/html_index.mustache +++ b/templates/rspec_api_documentation/html_index.mustache @@ -10,7 +10,7 @@