apipie-rails 0.5.20 → 1.2.3

data/lib/apipie/configuration.rb

@@ -1,31 +1,45 @@
 module Apipie
   class Configuration
+    extend Forwardable
 
     attr_accessor :app_name, :app_info, :copyright, :compress_examples,
       :markup, :disqus_shortname,
       :api_base_url, :doc_base_url, :required_by_default, :layout,
       :default_version, :debug, :version_in_url, :namespaced_resources,
-      :validate, :validate_value, :validate_presence, :validate_key, :authenticate, :doc_path,
+      :validate, :validate_value, :validate_presence, :validate_key, :action_on_non_validated_keys, :authenticate, :doc_path,
       :show_all_examples, :process_params, :update_checksum, :checksum_path,
       :link_extension, :record, :languages, :translate, :locale, :default_locale,
-      :persist_show_in_doc, :authorize,
-      :swagger_include_warning_tags, :swagger_content_type_input, :swagger_json_input_uses_refs,
-      :swagger_suppress_warnings, :swagger_api_host, :swagger_generate_x_computed_id_field,
-      :swagger_allow_additional_properties_in_response, :swagger_responses_use_refs
-
-    alias_method :validate?, :validate
-    alias_method :required_by_default?, :required_by_default
-    alias_method :namespaced_resources?, :namespaced_resources
-    alias_method :swagger_include_warning_tags?, :swagger_include_warning_tags
-    alias_method :swagger_json_input_uses_refs?, :swagger_json_input_uses_refs
-    alias_method :swagger_responses_use_refs?, :swagger_responses_use_refs
-    alias_method :swagger_generate_x_computed_id_field?, :swagger_generate_x_computed_id_field
+      :persist_show_in_doc, :authorize, :ignore_allow_blank_false
+
+    def_delegators :swagger, *Apipie::Generator::Swagger::Config.deprecated_methods
+
+    def swagger
+      Apipie::Generator::Swagger::Config.instance
+    end
+
+    def generator
+      Apipie::Generator::Config.instance
+    end
+
+    alias validate? validate
+    alias required_by_default? required_by_default
+    alias namespaced_resources? namespaced_resources
 
     # matcher to be used in Dir.glob to find controllers to be reloaded e.g.
     #
     #   "#{Rails.root}/app/controllers/api/*.rb"
     attr_accessor :api_controllers_matcher
 
+    # An object that responds to a `.call(controller)` method responsible for
+    # matching the correct controller action
+    attr_reader :api_action_matcher
+
+    def api_action_matcher=(callable)
+      raise 'Must implement .call method' unless callable.respond_to?(:call)
+
+      @api_action_matcher = callable
+    end
+
     # set to true if you want to reload the controllers at each refresh of the
     # documentation. It requires +:api_controllers_matcher+ to be set to work
     # properly.
@@ -44,35 +58,36 @@ module Apipie
 
     def reload_controllers?
       @reload_controllers = Rails.env.development? unless defined? @reload_controllers
-      return @reload_controllers && @api_controllers_matcher
+
+      @reload_controllers && @api_controllers_matcher
     end
 
     def validate_value
-      return (validate? && @validate_value)
+      validate? && @validate_value
     end
-    alias_method :validate_value?, :validate_value
+    alias validate_value? validate_value
 
     def validate_presence
-      return (validate? && @validate_presence)
+      validate? && @validate_presence
     end
-    alias_method :validate_presence?, :validate_presence
+    alias validate_presence? validate_presence
 
     def validate_key
-      return (validate? && @validate_key)
+      validate? && @validate_key
     end
-    alias_method :validate_key?, :validate_key
+    alias validate_key? validate_key
 
     def process_value?
       @process_params
     end
     # set to true if you want to use pregenerated documentation cache and avoid
-    # generating the documentation on runtime (usefull for production
+    # generating the documentation on runtime (useful for production
     # environment).
     # You can generate the cache by running
     #
     #     rake apipie:cache
     attr_accessor :use_cache
-    alias_method :use_cache?, :use_cache
+    alias use_cache? use_cache
 
     attr_writer :cache_dir
     def cache_dir
@@ -98,7 +113,7 @@ module Apipie
     end
 
     # array of controller names (strings) (might include actions as well)
-    # to be ignored # when generationg the documentation
+    # to be ignored # when generating the documentation
     # e.g. %w[Api::CommentsController Api::PostsController#post]
     attr_writer :ignored
     def ignored
@@ -146,19 +161,22 @@ module Apipie
     def initialize
       @markup = Apipie::Markup::RDoc.new
       @app_name = "Another API"
-      @app_info = HashWithIndifferentAccess.new
+      @app_info = ActiveSupport::HashWithIndifferentAccess.new
       @copyright = nil
       @validate = :implicitly
       @validate_value = true
       @validate_presence = true
       @validate_key = false
+      @action_on_non_validated_keys = :raise
       @required_by_default = false
-      @api_base_url = HashWithIndifferentAccess.new
+      @api_base_url = ActiveSupport::HashWithIndifferentAccess.new
+      @api_action_matcher = proc { |controller| controller.params[:action] }
       @doc_base_url = "/apipie"
       @layout = "apipie/apipie"
       @disqus_shortname = nil
       @default_version = "1.0"
       @debug = false
+      @ignore_allow_blank_false = false
       @version_in_url = true
       @namespaced_resources = false
       @doc_path = "doc"
@@ -173,14 +191,6 @@ module Apipie
       @translate = lambda { |str, locale| str }
       @persist_show_in_doc = false
       @routes_formatter = RoutesFormatter.new
-      @swagger_content_type_input = :form_data  # this can be :json or :form_data
-      @swagger_json_input_uses_refs = false
-      @swagger_include_warning_tags = false
-      @swagger_suppress_warnings = false #[105,100,102]
-      @swagger_api_host = "localhost:3000"
-      @swagger_generate_x_computed_id_field = false
-      @swagger_allow_additional_properties_in_response = false
-      @swagger_responses_use_refs = true
     end
   end
 end

data/lib/apipie/dsl_definition.rb

@@ -51,9 +51,6 @@ module Apipie
     end
 
     module Resource
-      # by default, the resource id is derived from controller_name
-      # it can be overwritten with.
-      #
       #    resource_id "my_own_resource_id"
       def resource_id(resource_id)
         Apipie.set_resource_id(@controller, resource_id)
@@ -70,7 +67,7 @@ module Apipie
       def short(short)
         _apipie_dsl_data[:short_description] = short
       end
-      alias :short_description :short
+      alias short_description short
 
       def path(path)
         _apipie_dsl_data[:path] = path
@@ -96,7 +93,7 @@ module Apipie
       #   # load paths from routes and don't provide description
       #   api
       #
-      def api(method, path, desc = nil, options={}) #:doc:
+      def api(method, path, desc = nil, options = {}) #:doc:
         return unless Apipie.active_dsl?
         _apipie_dsl_data[:api] = true
         _apipie_dsl_data[:api_args] << [method, path, desc, options]
@@ -105,7 +102,7 @@ module Apipie
       #   # load paths from routes
       #   api! "short description",
       #
-      def api!(desc = nil, options={}) #:doc:
+      def api!(desc = nil, options = {}) #:doc:
         return unless Apipie.active_dsl?
         _apipie_dsl_data[:api] = true
         _apipie_dsl_data[:api_from_routes] = { :desc => desc, :options =>options }
@@ -139,20 +136,20 @@ module Apipie
       #
       # Example:
       # api :desc => "Show user profile", :path => "/users/", :version => '1.0 - 3.4.2012'
-      # param :id, Fixnum, :desc => "User ID", :required => true
+      # param :id, Integer, :desc => "User ID", :required => true
       # desc <<-EOS
       #   Long description...
       # EOS
       def resource_description(options = {}, &block) #:doc:
         return unless Apipie.active_dsl?
-        raise ArgumentError, "Block expected" unless block_given?
+        raise ArgumentError, "Block expected" unless block
 
         dsl_data = ResourceDescriptionDsl.eval_dsl(self, &block)
         versions = dsl_data[:api_versions]
+        Apipie.set_controller_versions(self, versions)
         @apipie_resource_descriptions = versions.map do |version|
           Apipie.define_resource_description(self, version, dsl_data)
         end
-        Apipie.set_controller_versions(self, versions)
       end
     end
 
@@ -160,7 +157,7 @@ module Apipie
       def api_versions(*versions)
         _apipie_dsl_data[:api_versions].concat(versions)
       end
-      alias :api_version :api_versions
+      alias api_version api_versions
 
       # Describe the next method.
       #
@@ -177,8 +174,8 @@ module Apipie
         end
         _apipie_dsl_data[:description] = description
       end
-      alias :description :desc
-      alias :full_description :desc
+      alias description desc
+      alias full_description desc
 
       # describe next method with document in given path
       # in convension, these doc located under "#{Rails.root}/doc"
@@ -218,7 +215,7 @@ module Apipie
       #     puts "hello world"
       #   end
       #
-      def error(code_or_options, desc=nil, options={}) #:doc:
+      def error(code_or_options, desc = nil, options = {}) #:doc:
         return unless Apipie.active_dsl?
         _apipie_dsl_data[:errors] << [code_or_options, desc, options]
       end
@@ -244,16 +241,18 @@ module Apipie
               method_params = self.class._apipie_get_method_params(action_name)
 
               if Apipie.configuration.validate_presence?
-                method_params.each do |_, param|
-                  # check if required parameters are present
-                  raise ParamMissing.new(param) if param.required && !params.has_key?(param.name)
+                Validator::BaseValidator.raise_if_missing_params do |missing|
+                  method_params.each do |_, param|
+                    # check if required parameters are present
+                    missing << param if param.required && !params.key?(param.name)
+                  end
                 end
               end
 
               if Apipie.configuration.validate_value?
                 method_params.each do |_, param|
                   # params validations
-                  param.validate(params[:"#{param.name}"]) if params.has_key?(param.name)
+                  param.validate(params[:"#{param.name}"]) if params.key?(param.name)
                 end
               end
 
@@ -262,7 +261,9 @@ module Apipie
               if Apipie.configuration.validate_key?
                 params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_pair do |param, _|
                   # params allowed
-                  raise UnknownParam.new(param) if method_params.select {|_,p| p.name.to_s == param.to_s}.empty?
+                  if method_params.none? {|_,p| p.name.to_s == param.to_s}
+                    self.class._apipie_handle_validate_key_error params, param
+                  end
                 end
               end
 
@@ -270,13 +271,13 @@ module Apipie
                 @api_params ||= {}
                 method_params.each do |_, param|
                   # params processing
-                  @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.has_key?(param.name)
+                  @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.key?(param.name)
                 end
               end
             end
           end
 
-          if (Apipie.configuration.validate == :implicitly || Apipie.configuration.validate == true)
+          if Apipie.configuration.validate == :implicitly || Apipie.configuration.validate == true
             old_method = instance_method(description.method)
 
             define_method(description.method) do |*args|
@@ -286,7 +287,16 @@ module Apipie
               old_method.bind(self).call(*args)
             end
           end
+        end
+      end
 
+      def _apipie_handle_validate_key_error params, param
+        case Apipie.configuration.action_on_non_validated_keys
+        when :raise
+          raise UnknownParam, param
+        when :skip
+          params.delete(param)
+          Rails.logger.warn(UnknownParam.new(param).to_s)
         end
       end
 
@@ -349,7 +359,7 @@ module Apipie
       # Reuses param group for this method. The definition is looked up
       # in scope of this controller. If the group was defined in
       # different controller, the second param can be used to specify it.
-      # when using action_aware parmas, you can specify :as =>
+      # when using action_aware params, you can specify :as =>
       # :create or :update to explicitly say how it should behave
       def param_group(name, scope_or_options = nil, options = {})
         if scope_or_options.is_a? Hash
@@ -391,7 +401,7 @@ module Apipie
       #     render json: {user: {name: "Alfred"}}
       #   end
       #
-      def returns(pgroup_or_options, desc_or_options=nil, options={}, &block) #:doc:
+      def returns(pgroup_or_options, desc_or_options = nil, options = {}, &block) #:doc:
         return unless Apipie.active_dsl?
 
 
@@ -496,7 +506,7 @@ module Apipie
       end
 
       def _apipie_update_meta(method_desc, dsl_data)
-        return unless dsl_data[:meta] && dsl_data[:meta].is_a?(Hash)
+        return unless dsl_data[:meta].is_a?(Hash)
 
         method_desc.metadata ||= {}
         method_desc.metadata.merge!(dsl_data[:meta])
@@ -514,15 +524,17 @@ module Apipie
         end
       end
       # backwards compatibility
-      alias_method :apipie_update_params, :apipie_update_methods
+      alias apipie_update_params apipie_update_methods
 
       def _apipie_concern_subst
-        @_apipie_concern_subst ||= {:controller_path => self.controller_path,
-                                    :resource_id => Apipie.get_resource_name(self)}
+        @_apipie_concern_subst ||= {
+          controller_path: self.controller_path,
+          resource_id: Apipie.get_resource_id(self)
+        }
       end
 
       def _apipie_perform_concern_subst(string)
-        return _apipie_concern_subst.reduce(string) do |ret, (key, val)|
+        _apipie_concern_subst.reduce(string) do |ret, (key, val)|
           ret.gsub(":#{key}", val)
         end
       end

data/lib/apipie/error_description.rb

@@ -10,7 +10,7 @@ module Apipie
                                    options)
     end
 
-    def initialize(code_or_options, desc=nil, options={})
+    def initialize(code_or_options, desc = nil, options = {})
       if code_or_options.is_a? Hash
         code_or_options.symbolize_keys!
         @code = code_or_options[:code]
@@ -31,10 +31,10 @@ module Apipie
       end
     end
 
-    def to_json
+    def to_json(lang)
       {
         :code => code,
-        :description => description,
+        :description => Apipie.app.translate(description, lang),
         :metadata => metadata
       }
     end

data/lib/apipie/errors.rb

@@ -24,6 +24,20 @@ module Apipie
     end
   end
 
+  class ParamMultipleMissing < ParamError
+    attr_accessor :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def to_s
+      params.map do |param|
+        ParamMissing.new(param).to_s
+      end.join("\n")
+    end
+  end
+
   class ParamMissing < DefinedParamError
     def to_s
       unless @param.options[:missing_message].nil?
@@ -60,27 +74,13 @@ module Apipie
 
   class ResponseDoesNotMatchSwaggerSchema < Error
     def initialize(controller_name, method_name, response_code, error_messages, schema, returned_object)
-      @controller_name = controller_name
-      @method_name = method_name
-      @response_code = response_code
-      @error_messages = error_messages
-      @schema = schema
-      @returned_object = returned_object
-    end
-
-    def to_s
-      "Response does not match swagger schema (#{@controller_name}##{@method_name} #{@response_code}): #{@error_messages}\nSchema: #{JSON(@schema)}\nReturned object: #{@returned_object}"
+      super("Response does not match swagger schema (#{controller_name}##{method_name} #{response_code}): #{error_messages}\nSchema: #{JSON(schema)}\nReturned object: #{returned_object}")
     end
   end
 
   class NoDocumentedMethod < Error
     def initialize(controller_name, method_name)
-      @method_name = method_name
-      @controller_name = controller_name
-    end
-
-    def to_s
-      "There is no documented method #{@controller_name}##{@method_name}"
+      super("There is no documented method #{controller_name}##{method_name}")
     end
   end
 end

data/lib/apipie/extractor/collector.rb

@@ -19,21 +19,21 @@ module Apipie
       def ignore_call?(record)
         return true unless record[:controller]
         return true if @ignored.include?(record[:controller].name)
-        return true if @ignored.include?("#{Apipie.get_resource_name(record[:controller].name)}##{record[:action]}")
+        return true if @ignored.include?("#{Apipie.get_resource_id(record[:controller].name)}##{record[:action]}")
         return true unless @api_controllers_paths.include?(controller_full_path(record[:controller]))
       end
 
       def handle_record(record)
-        add_to_records(record)
         if ignore_call?(record)
           Extractor.logger.info("REST_API: skipping #{record_to_s(record)}")
         else
+          add_to_records(record)
           refine_description(record)
         end
       end
 
       def add_to_records(record)
-        key = "#{Apipie.get_resource_name(record[:controller])}##{record[:action]}"
+        key = "#{Apipie.get_resource_id(record[:controller])}##{record[:action]}"
         @records[key] << record
       end
 
@@ -96,7 +96,7 @@ module Apipie
       end
 
       def add_routes_info(desc)
-        api_prefix = Apipie.api_base_url.sub(/\/$/,"")
+        api_prefix = Apipie.api_base_url.sub(%r{/$},"")
         desc[:api] = Apipie::Extractor.apis_from_routes[[desc[:controller].name, desc[:action]]]
         if desc[:api]
           desc[:params].each do |name, param|
@@ -114,4 +114,3 @@ module Apipie
     end
   end
 end
-

data/lib/apipie/extractor/recorder.rb

@@ -9,7 +9,7 @@ module Apipie
 
       def analyse_env(env)
         @verb = env["REQUEST_METHOD"].to_sym
-        @path = env["PATH_INFO"].sub(/^\/*/,"/")
+        @path = env["PATH_INFO"].sub(%r{^/*},"/")
         @query = env["QUERY_STRING"] unless env["QUERY_STRING"].blank?
         @params = Rack::Utils.parse_nested_query(@query)
         @params.merge!(env["action_dispatch.request.request_parameters"] || {})
@@ -24,7 +24,7 @@ module Apipie
 
       def analyse_controller(controller)
         @controller = controller.class
-        @action = controller.params[:action]
+        @action = Apipie.configuration.api_action_matcher.call(controller)
       end
 
       def analyse_response(response)
@@ -44,11 +44,13 @@ module Apipie
         @path = request.path
         @params = request.request_parameters
         if [:POST, :PUT, :PATCH, :DELETE].include?(@verb)
-          @request_data = @params
+          @request_data = request.content_type == "multipart/form-data" ? reformat_multipart_data(@params) : @params
         else
           @query = request.query_string
         end
-        @response_data = parse_data(response.body)
+        if response.media_type != 'application/pdf'
+          @response_data = parse_data(response.body)
+        end
         @code = response.code
       end
 
@@ -64,8 +66,14 @@ module Apipie
         lines = ["Content-Type: multipart/form-data; boundary=#{MULTIPART_BOUNDARY}",'']
         boundary = "--#{MULTIPART_BOUNDARY}"
         form.each do |key, attrs|
-          if attrs.is_a?(String)
+          if attrs.is_a?(String) # rubocop:disable Style/CaseLikeIf
             lines << boundary << content_disposition(key) << "Content-Length: #{attrs.size}" << '' << attrs
+          elsif attrs.is_a?(Rack::Test::UploadedFile) || attrs.is_a?(ActionDispatch::Http::UploadedFile)
+            reformat_uploaded_file(boundary, attrs, key, lines)
+          elsif attrs.is_a?(Array)
+            reformat_array(boundary, attrs, key, lines)
+          elsif attrs.is_a?(TrueClass) || attrs.is_a?(FalseClass)
+            reformat_boolean(boundary, attrs, key, lines)
           else
             reformat_hash(boundary, attrs, lines)
           end
@@ -86,6 +94,24 @@ module Apipie
         end
       end
 
+      def reformat_boolean(boundary, attrs, key, lines)
+        lines << boundary << content_disposition(key)
+        lines << '' << attrs.to_s
+      end
+
+      def reformat_array(boundary, attrs, key, lines)
+        attrs.each do |item|
+          lines << boundary << content_disposition("#{key}[]")
+          lines << '' << item
+        end
+      end
+
+      def reformat_uploaded_file(boundary, file, key, lines)
+        lines << boundary << %{#{content_disposition(key)}; filename="#{file.original_filename}"}
+        lines << "Content-Length: #{file.size}" << "Content-Type: #{file.content_type}" << "Content-Transfer-Encoding: binary"
+        lines << '' << %{... contents of "#{key}" ...}
+      end
+
       def content_disposition(name)
         %{Content-Disposition: form-data; name="#{name}"}
       end
@@ -150,7 +176,7 @@ module Apipie
       end
 
       module FunctionalTestRecording
-        def process(*, **) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+        def process(*) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
           ret = super
           if Apipie.configuration.record
             Apipie::Extractor.call_recorder.analyze_functional_test(self)
@@ -160,6 +186,7 @@ module Apipie
         ensure
           Apipie::Extractor.clean_call_recorder
         end
+        ruby2_keywords :process if respond_to?(:ruby2_keywords, true)
       end
     end
   end

data/lib/apipie/extractor/writer.rb

@@ -103,7 +103,7 @@ module Apipie
         call = call.stringify_keys
         ordered_call = OrderedHash.new
         %w[title verb path versions query request_data response_data code show_in_doc recorded].each do |k|
-          next unless call.has_key?(k)
+          next unless call.key?(k)
           ordered_call[k] = case call[k]
                      when ActiveSupport::HashWithIndifferentAccess
                        convert_file_value(call[k]).to_hash
@@ -116,9 +116,10 @@ module Apipie
 
       def convert_file_value hash
         hash.each do |k, v|
-          if (v.is_a?(Rack::Test::UploadedFile) || v.is_a?(ActionDispatch::Http::UploadedFile))
+          case v
+          when Rack::Test::UploadedFile, ActionDispatch::Http::UploadedFile
             hash[k] = "<FILE CONTENT '#{v.original_filename}'>"
-          elsif v.is_a?(Hash)
+          when Hash
             hash[k] = convert_file_value(v)
           end
         end
@@ -134,8 +135,8 @@ module Apipie
         old_examples = self.load_recorded_examples
         merged_examples = []
         (new_examples.keys + old_examples.keys).uniq.each do |key|
-          if new_examples.has_key?(key)
-            if old_examples.has_key?(key)
+          if new_examples.key?(key)
+            if old_examples.key?(key)
               records = deep_merge_examples(new_examples[key], old_examples[key])
             else
               records = new_examples[key]
@@ -190,7 +191,7 @@ module Apipie
       end
 
       def load_old_examples
-        if File.exists?(@examples_file)
+        if File.exist?(@examples_file)
           if defined? SafeYAML
             return YAML.load_file(@examples_file, :safe=>false)
           else
@@ -295,7 +296,7 @@ module Apipie
       end
 
       def controller_content
-        raise ControllerNotFound.new unless controller_path && File.exists?(controller_path)
+        raise ControllerNotFound.new unless controller_path && File.exist?(controller_path)
         @controller_content ||= File.read(controller_path)
       end
 
@@ -323,7 +324,7 @@ module Apipie
           desc ||= case @action.to_s
                    when "show", "create", "update", "destroy"
                      name = name.singularize
-                     "#{@action.capitalize} #{name =~ /^[aeiou]/ ? "an" : "a"} #{name}"
+                     "#{@action.capitalize} #{name =~ /^[aeiou]/ ? 'an' : 'a'} #{name}"
                    when "index"
                      "List #{name}"
                    end
@@ -407,12 +408,11 @@ module Apipie
           if line =~ /\s*\b(module|class|def)\b /
             break
           end
-          if line =~ /do\s*(\|.*?\|)?\s*$/
-            block_level -= 1
-            if block_level == 0
-              added_lines.concat(lines_to_add)
-              lines_to_add = []
-            end
+          next unless line =~ /do\s*(\|.*?\|)?\s*$/
+          block_level -= 1
+          if block_level == 0
+            added_lines.concat(lines_to_add)
+            lines_to_add = []
           end
         end
         return added_lines.reverse.join

data/lib/apipie/extractor.rb

@@ -15,13 +15,10 @@ class Apipie::Railtie
         end
       end
     end
-    app.middleware.use ::Apipie::Extractor::Recorder::Middleware
 
-    if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
-      ActionController::TestCase::Behavior.instance_eval do
-        prepend Apipie::Extractor::Recorder::FunctionalTestRecording
-      end
-    else
+    if Apipie.configuration.record
+      app.middleware.use ::Apipie::Extractor::Recorder::Middleware
+
       ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
       ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
     end
@@ -87,7 +84,7 @@ module Apipie
       def apis_from_routes
         return @apis_from_routes if @apis_from_routes
 
-        @api_prefix = Apipie.api_base_url.sub(/\/$/,"")
+        @api_prefix = Apipie.api_base_url.sub(%r{/$},"")
         populate_api_routes
         update_api_descriptions
 
@@ -160,10 +157,10 @@ module Apipie
       def update_api_descriptions
         apis_from_docs = all_apis_from_docs
         @apis_from_routes.each do |(controller, action), new_apis|
-          method_key = "#{Apipie.get_resource_name(controller.safe_constantize || next)}##{action}"
+          method_key = "#{Apipie.get_resource_id(controller.safe_constantize || next)}##{action}"
           old_apis = apis_from_docs[method_key] || []
           new_apis.each do |new_api|
-            new_api[:path].sub!(/\(\.:format\)$/,"") if new_api[:path]
+            new_api[:path]&.sub!(/\(\.:format\)$/,"")
             old_api = old_apis.find do |api|
               api[:path] == "#{@api_prefix}#{new_api[:path]}"
             end