Ejemplo n.º 1
0
def get_api_doc(request):
    """
    @param request: HttpRequest
    @return: str, html
    """
    f, args, kwars = resolve(request.path)
    endpoint = utils.Endpoint(f.__doc__, request.path)

    doc = utils.get_api_doc([endpoint], request.path, request.path)
    return doc
Ejemplo n.º 2
0
def get_api_doc(request):
    """
    @param request: HttpRequest
    @return: str, html
    """
    f, args, kwars = resolve(request.path)
    endpoint = utils.Endpoint(f.__doc__, request.path)

    doc = utils.get_api_doc([endpoint], request.path, request.path)
    return doc
Ejemplo n.º 3
0
def _get_helper(
    application,
    handlers=None,
    server_name=None,
    request=None,
    is_root=False,
):
    """
    @param handlers: list(RequestHandler), list of handlers to limit
    the documentation for. If not specified, documentation will be
    generated for all handlers.
    @param server_name: str, will be used as the title in the generated
    HTML.
    @param request: HTTPRequest|None
    @param is_root: bool
    @return: str
    """
    urls = application.handlers[0][1]
    classes = [h.__class__ for h in handlers] if handlers else None
    server_name = server_name or application.settings.get('server_name', "")
    endpoints = []
    for url in urls:
        if classes and not url.handler_class in classes:
            continue
        if url.handler_class.__module__.startswith('tornado.'):
            continue
        if url.handler_class.__name__ == DocHandler.__name__:
            continue
        endpoint = utils.Endpoint(
            url.handler_class.__doc__,
            url.regex.pattern,
        )
        endpoints.append(endpoint)
    return utils.get_api_doc(
        endpoints,
        server_name,
        request_url=request.full_url(),
        is_root=is_root,
    )
Ejemplo n.º 4
0
def _get_helper(application,
    handlers=None,
    server_name=None,
    request=None,
    is_root=False,
    ):
    """
    @param handlers: list(RequestHandler), list of handlers to limit
    the documentation for. If not specified, documentation will be
    generated for all handlers.
    @param server_name: str, will be used as the title in the generated
    HTML.
    @param request: HTTPRequest|None
    @param is_root: bool
    @return: str
    """
    urls = application.handlers[0][1]
    classes = [h.__class__ for h in handlers] if handlers else None
    server_name = server_name or application.settings.get('server_name', "")
    endpoints = []
    for url in urls:
        if classes and not url.handler_class in classes:
            continue
        if url.handler_class.__module__.startswith('tornado.'):
            continue
        if url.handler_class.__name__ == DocHandler.__name__:
            continue
        endpoint = utils.Endpoint(
                url.handler_class.__doc__,
                url.regex.pattern,
                )
        endpoints.append(endpoint)
    return utils.get_api_doc(endpoints, server_name,
            request_url=request.full_url(),
            is_root=is_root,
            )