swaggergenerator3/shortcuts.py
def generate_docs(self, api_docs_list, filename=None):
        """Generate docs by iterating over the api_doc_list and store the generated doc in
        filename.

        Args:
            api_docs_list (list): a list of apis attributes.
                ** url **: url name
                ** method **: API method.
                ** params **: API params.
                ** headers **: API headers.
                ** description ** : api docstring
            filename (str): filename to store the api documentations. [no extension needed.]

        Returns:

        """
        print("Welcome to swagger documentation generation!!")
        for api_doc in api_docs_list:
            self.add_endpoint_to_generator(
                api_doc['url'], api_doc['method'], api_doc.get('params'),
                api_doc.get('headers'), api_doc.get('description'), api_doc.get('summary'))

        self.generate_files(filename)
Generate docs by iterating over the api_doc_list and store the generated doc in
        filename.

        Args:
            api_docs_list (list): a list of apis attributes.
                ** url **: url name
                ** method **: API method.
                ** params **: API params.
                ** headers **: API headers.
                ** description ** : api docstring
            filename (str): filename to store the api documentations. [no extension needed.]

        Returns:

        
Generate docs by iterating over the api_doc_list and store the generated doc in
filename.
Generate docs by iterating over the api_doc_list and store the generated doc in filename .
def generate_docs(self, api_docs_list, filename=None):
        print("Welcome to swagger documentation generation!!")
        for api_doc in api_docs_list:
            self.add_endpoint_to_generator(
                api_doc['url'], api_doc['method'], api_doc.get('params'),
                api_doc.get('headers'), api_doc.get('description'), api_doc.get('summary'))
        self.generate_files(filename)
def generate_docs ( self , api_docs_list , filename = None ) : print ( "Welcome to swagger documentation generation!!" ) for api_doc in api_docs_list : self . add_endpoint_to_generator ( api_doc [ 'url' ] , api_doc [ 'method' ] , api_doc . get ( 'params' ) , api_doc . get ( 'headers' ) , api_doc . get ( 'description' ) , api_doc . get ( 'summary' ) ) self . generate_files ( filename )
Generate docs by iterating over the api_doc_list and store the generated doc in
filename.
Generate docs by iterating over the api_doc_list and store the generated doc in filename .
"""Generate docs by iterating over the api_doc_list and store the generated doc in
        filename.

        Args:
            api_docs_list (list): a list of apis attributes.
                ** url **: url name
                ** method **: API method.
                ** params **: API params.
                ** headers **: API headers.
                ** description ** : api docstring
            filename (str): filename to store the api documentations. [no extension needed.]

        Returns:

        """
None
self
api_docs_list
a list of apis attributes.
url **: url name
method **: API method.
params **: API params.
headers **: API headers.
description ** : api docstring
a list of apis attributes . url ** : url name method ** : API method . params ** : API params . headers ** : API headers . description ** : api docstring
filename
filename to store the api documentations. [no extension needed.]
filename to store the api documentations . [ no extension needed . ]