HTMLDocumentationHandler

class ramose.HTMLDocumentationHandler(api_manager)

Bases: DocumentationHandler

This class provides the main structure for returning a human-readable documentation of all the operations described in the configuration files handled by the APIManager specified as input.

__title(conf)

This method returns the title string defined in the API specification.

__sidebar(conf)

This method builds the sidebar of the API documentation

__header(conf)

This method builds the header of the API documentation

__parameters()

__operations(conf)

This method returns the description of all the operations defined in the API.

__footer()

This method returns the footer of the API documentation.

__css()

__css_path(css_path=None)

Add link to a css file if specified in argument -css

logger_ramose()

This method adds logging info to a local file

__parse_logger_ramose()

This method reads logging info stored into a local file, so as to be browsed in the dashboard. Returns: the html including the list of URLs of current working APIs and basic logging info

get_documentation(css_path=None, base_url=None)

This method generates the HTML documentation of an API described in configuration file.

get_index(css_path=None)

This method generates the index of all the HTML documentations that can be created from the configuration file.

store_documentation(file_path, css_path=None)

This method stores the HTML documentation of an API in a file.

clean_log(l, api_url)

This method parses logs lines into structured data.