Web component¶
The BioThings SDK web component contains tools used to generate and customize an API, given an Elasticsearch index with data. The web component uses the Tornado Web Server to respond to incoming API requests.
Server boot script¶
A simple Biothings API implementation.
Process command line arguments to setup the API.
Add additional applicaion settings like handlers.
port: the port to start the API on, default 8000debug: start the API in debug mode, default Falseaddress: the address to start the API on, default 0.0.0.0autoreload: restart the server when file changes, default Falseconf: choose an alternative setting, default configdir: path to app directory. default: current working directory
-
index_base.main(app_settings=None, use_curl=False)¶ Start a Biothings API Server
- Parameters
app_handlers – additional web handlers to add to the app
app_settings – `Tornado application settings dictionary
<http://www.tornadoweb.org/en/stable/web.html#tornado.web.Application.settings>`_ :param use_curl: Overide the default simple_httpclient with curl_httpclient <https://www.tornadoweb.org/en/stable/httpclient.html>
Settings¶
Config module¶
BiothingWebSettings¶
-
class
biothings.web.settings.BiothingWebSettings(config=None, parent=None, **kwargs)[source]¶ A container for the settings that configure the web API.
Environment variables can override settings of the same names.
Default values are defined in biothings.web.settings.default.
- Parameters
config – a module that configures this biothing or its fully qualified name, or its module file path.
-
configure_logger(logger)[source]¶ Configure a logger’s formatter to use the format defined in this web setting.
-
get_app(settings=False, handlers=None)[source]¶ Return the tornado.web.Application defined by this settings. This is primarily how an HTTP server interacts with this class. Additional settings and handlers accepted as parameters.
-
static
load_class(kls)[source]¶ Ensure config is a module. If config does not evaluate, Return default if it’s provided.