module SwaggerDocsGenerator::Methods
# Methods
for controller
Methods
adding to controller parsing in rails appliation
Public Instance Methods
swagger_controller(description)
click to toggle source
Create json file for controller. Create all temporary file for each controller.
# File lib/swagger_docs_generator/methods.rb, line 11 def swagger_controller(description) parse = ParserController.new(description) parse.adding_tag end
Also aliased as: scontroller
swagger_definition(name, &block)
click to toggle source
Complete definitions objects for each controller.
# File lib/swagger_docs_generator/methods.rb, line 24 def swagger_definition(name, &block) parse = ParserDefinition.new(name, &block) parse.adding_definition end
Also aliased as: sdefinition
swagger_doc(action, &block)
click to toggle source
Complete json file with datas to method and controller. Each action to controller is writing in temporary file.
# File lib/swagger_docs_generator/methods.rb, line 18 def swagger_doc(action, &block) parse = ParserAction.new(action, &block) parse.adding_path end
Also aliased as: sdoc
swagger_readme(readme_file)
click to toggle source
Create section for display a README in top to documentation
# File lib/swagger_docs_generator/methods.rb, line 30 def swagger_readme(readme_file) parse = ParserReadme.new(readme_file) parse.adding_readme end
Also aliased as: sreadme