Path segments RFC 6570

- Path segments extensions were not following the RFC 6570

Author: joel

features/api_blueprint_documentation.feature

@@ -354,7 +354,7 @@ Feature: Generate API Blueprint documentation from test examples
                   ]
                 }
 
-    ## Single Order [/orders/:id{?optional=:optional}]
+    ## Single Order [/orders{/id}{?optional=:optional}]
 
     + Parameters
       + id: 1 (required, string) - Order id

lib/rspec_api_documentation/views/api_blueprint_index.rb

@@ -23,7 +23,7 @@ def sections
             {
               "has_attributes?".to_sym => attrs.size > 0,
               "has_parameters?".to_sym => params.size > 0,
-              route: route,
+              route: format_route(examples[0]),
               route_name: examples[0][:route_name],
               attributes: attrs,
               parameters: params,
@@ -45,6 +45,17 @@ def examples
 
       private
 
+      # APIB follows the RFC 6570 to format URI templates.
+      # According to it, path segment expansion (used to describe URI path
+      # hierarchies) should be represented by `{/var}` and not by `/:var`
+      # For example `/posts/:id` should become `/posts{/id}`
+      # cf. https://github.com/apiaryio/api-blueprint/blob/format-1A/API%20Blueprint%20Specification.md#431-resource-section
+      # cf. https://tools.ietf.org/html/rfc6570#section-3.2.6
+      def format_route(example)
+        route_uri = example[:route_uri].gsub(/\/:(.*?)([.\/?{]|$)/, '{/\1}\2')
+        "#{route_uri}#{example[:route_optionals]}"
+      end
+
       # APIB has both `parameters` and `attributes`. This generates a hash
       # with all of its properties, like name, description, required.
       #   {

spec/views/api_blueprint_index_spec.rb

@@ -109,7 +109,7 @@
 
         post_examples = post_route[:http_methods].map { |http_method| http_method[:examples] }.flatten
         expect(post_examples.size).to eq 2
-        expect(post_route[:route]).to eq "/posts/:id"
+        expect(post_route[:route]).to eq "/posts{/id}"
         expect(post_route[:route_name]).to eq "Single Post"
         expect(post_route[:has_parameters?]).to eq true
         expect(post_route[:parameters]).to eq [{
@@ -130,7 +130,7 @@
 
         post_w_optionals_examples = post_route_with_optionals[:http_methods].map { |http_method| http_method[:examples] }.flatten
         expect(post_w_optionals_examples.size).to eq 1
-        expect(post_route_with_optionals[:route]).to eq "/posts/:id{?option=:option}"
+        expect(post_route_with_optionals[:route]).to eq "/posts{/id}{?option=:option}"
         expect(post_route_with_optionals[:route_name]).to eq "Single Post"
         expect(post_route_with_optionals[:has_parameters?]).to eq true
         expect(post_route_with_optionals[:parameters]).to eq [{