routes

HTTP API framework similar to flask.

Classes

API(name)

Bases: object

API root object.

Parameters:

Name	Type	Description	Default
name	str	URL-safe unique root name of the API	required

Examples:

from pyrevit import routes
api = routes.API("pyrevit-core")
@api.route('/sessions/', methods=['POST'])
def reload_pyrevit(uiapp):
    new_session_id = sessionmgr.reload_pyrevit()
    return {"session_id": new_session_id}

Source code in pyrevitlib/pyrevit/routes/__init__.py

def __init__(self, name):
    self.name = name

Attributes

name = name instance-attribute

Functions

route(pattern, methods=['GET'])

Define a new route on this API.

Source code in pyrevitlib/pyrevit/routes/__init__.py

def route(self, pattern, methods=['GET']):
    """Define a new route on this API."""
    def __func_wrapper__(f):
        for method in methods:
            add_route(
                api_name=self.name,
                pattern=pattern,
                method=method,
                handler_func=f
                )
        return f
    return __func_wrapper__

Functions

active_routes_api()

Activates routes API.

Source code in pyrevitlib/pyrevit/routes/__init__.py

def active_routes_api():
    """Activates routes API."""
    from pyrevit.routes import api