pyrevit.routes.server¶
Handles http api routing and serving with usage similar to flask.
-
class
pyrevit.routes.server.
Request
(path='/', method='GET', data=None, params=None)¶ Request wrapper object
-
add_header
(key, value)¶ Add new header key:value
-
callback_url
¶ Request callback url, if provided in payload
-
headers
¶ Request headers dict
-
params
¶ Request parameters
-
-
class
pyrevit.routes.server.
Response
(status=200, data=None, headers=None)¶ Response wrapper object
-
add_header
(key, value)¶ Add new header key:value
-
headers
¶ Response headers dict
-
-
pyrevit.routes.server.
init
()¶ Initialize routes. Reset all registered routes and shutdown servers
-
pyrevit.routes.server.
activate_server
()¶ Activate routes server for this host instance
-
pyrevit.routes.server.
deactivate_server
()¶ Deactivate the active routes server for this host instance
-
pyrevit.routes.server.
get_active_server
()¶ Get active routes server for this host instance
-
pyrevit.routes.server.
make_response
(data, status=200, headers=None)¶ Create Reponse object with
-
pyrevit.routes.server.
get_routes
(api_name)¶ Get all registered routes for given API name
Parameters: api_name (str) – unique name of the api
-
pyrevit.routes.server.
add_route
(api_name, pattern, method, handler_func)¶ Add new route for given API name
Parameters: - api_name (str) – unique name of the api
- pattern (str) – route pattern
- method (str) – method name
- handler_func (function) – route handler function
-
pyrevit.routes.server.
remove_route
(api_name, pattern, method)¶ Remove previously registered route for given API name
Parameters: - api_name (str) – unique name of the api
- pattern (str) – route pattern
- method (str) – method name