py4cytoscape.commands.cyrest_api

cyrest_api(base_url='http://127.0.0.1:1234/v1')

Open Swagger docs for CyREST API.

Opens Swagger docs in default browser for a live instance of CyREST operations.

Note that to open a Swagger window, you may need to configure your browser to allow pop-up windows.

Parameters

base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://127.0.0.1:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

True

Return type

bool

Raises

requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> cyrest_api() # loads Swagger CyREST API into browser
True