web.rst

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

biothings.www.index_base

biothings.www.index_base.main

Settings

biothings.www.settings

Config module

BiothingWebSettings

biothings.www.settings.BiothingWebSettings

BiothingESWebSettings

biothings.www.settings.BiothingESWebSettings

Handlers

BaseHandler

biothings.www.api.helper.BaseHandler

BaseESRequestHandler

biothings.www.api.es.handlers.base_handler.BaseESRequestHandler

BiothingHandler

biothings.www.api.es.handlers.biothing_handler.BiothingHandler

QueryHandler

biothings.www.api.es.handlers.query_handler.QueryHandler

MetadataHandler

biothings.www.api.es.handlers.metadata_handler.MetadataHandler

Elasticsearch Query Builder

biothings.www.api.es.query_builder.ESQueries

biothings.www.api.es.query_builder.ESQueryBuilder

Elasticsearch Query

biothings.www.api.es.query.ESQuery

Elasticsearch Result Transformer

biothings.www.api.es.transform.ESResultTransformer