class OpenApiAnnotator::Config
Public Instance Methods
application_controller_class()
click to toggle source
# File lib/open_api_annotator/config.rb, line 29 def application_controller_class if application_controller_class_name application_controller_class_name.constantize else unless defined?(ApplicationController) raise <<~EOL Expected to define ApplicationController or set custom class like: ``` OpenApiAnnotator.configure do |config| config.application_controller_class = BaseSerializer end ``` EOL end ApplicationController end end
application_serializer_class()
click to toggle source
# File lib/open_api_annotator/config.rb, line 10 def application_serializer_class if application_serializer_class_name application_serializer_class_name.constantize else unless defined?(ApplicationSerializer) raise <<~EOL Expected to define ApplicationSerializer or set custom class like: ``` OpenApiAnnotator.configure do |config| config.application_serializer_class = BaseSerializer end ``` EOL end ApplicationSerializer end end
validate!()
click to toggle source
# File lib/open_api_annotator/config.rb, line 48 def validate! validate_info! validate_destination_path! validate_path_regexp! validate_application_controller_class_name! validate_application_serializer_class_name! validate_always_required_fields! end
validate_always_required_fields!()
click to toggle source
# File lib/open_api_annotator/config.rb, line 100 def validate_always_required_fields! # Do nothing end
validate_application_controller_class_name!()
click to toggle source
# File lib/open_api_annotator/config.rb, line 96 def validate_application_controller_class_name! # Do nothing end
validate_application_serializer_class_name!()
click to toggle source
# File lib/open_api_annotator/config.rb, line 92 def validate_application_serializer_class_name! # Do nothing end
validate_destination_path!()
click to toggle source
# File lib/open_api_annotator/config.rb, line 74 def validate_destination_path! unless destination_path raise InvalidError, <<~EOL You have to set `config.destination_path` like: ``` OpenApiAnnotator.configure do |config| config.destination_path = Rails.root.join("api_spec.yml") end ``` EOL end end
validate_info!()
click to toggle source
# File lib/open_api_annotator/config.rb, line 57 def validate_info! unless info raise InvalidError, <<~EOL You have to set `OpenApi::Info` to `config.info` like: ``` OpenApiAnnotator.configure do |config| config.info = OpenApi::Info.new(title: "Book API", version: "1") end ``` You can see the detail of `OpenApi::Info` in https://www.rubydoc.info/gems/open_api/OpenApi/Info EOL end end
validate_path_regexp!()
click to toggle source
# File lib/open_api_annotator/config.rb, line 88 def validate_path_regexp! # Do nothing end