Intelligent APIs for a more connected web.

A BD2K/Network-of-BioThings project.

SmartAPI allows API publishers to annotate their services and input/output parameters in a structured and identifiable manner, based on a standard JSON-LD format for biomedical APIs and services. By indexing and visualizing these descriptions as Linked Data in a Elasticsearch back-end, researchers can seamlessly identify the services that consume or return desired parameters, and automatically compose services in workflows that yield new insights.

Presentation: http://bit.ly/smartAPIslides
Contact: [email protected]

1. Install Elasticsearch (version 6.x) at localhost:9200 (follow this instruction) or install with docker (follow this instruction)

2. Clone this repo

   git clone https://github.com/SmartAPI/smartAPI.git
   

3. Install system packages (on Ubuntu, for example)

   sudo apt install libcurl4-openssl-dev libssl-dev aws-cli
   

4. Install python dependencies after navigating to root smartAPI directory

   cd smartAPI
   pip install -r requirements.txt
   

5. Navigate to SmartAPI source files and create a config_key.py under src

   cd src
   touch config_key.py
   

6. Update config_key.py with

   COOKIE_SECRET = '<Any Random String>'
   GITHUB_CLIENT_ID = '<your Github application Client ID>'
   GITHUB_CLIENT_SECRET = '<your Github application Client Secret>'
   SLACK_WEBHOOKS = [ 
       {
   	    "tag": '<string>' or '<list of strings>', # (optional)
   	    "webhook": '<insert webhook URL>', 
   	    "template": '<slack markdown string with variables included as {variable_name}>' # (optional)
       }
   ] # (optional) 
   

   For Github incorporation, follow this instruction to create your Github Client ID and Secret.
   Enter any Application name, http://localhost:8000/ for Homepage URL and http://localhost:8000/oauth for Authorization callback URL.

   For SLACK_WEBHOOKS (optional), the list may not be included if one does not want Slack notifications pushed every time a new API is added to the smartAPI registry.

   Alternatively, if one wants slack notifications sent to more than one channel, one may list more than one dict in the SLACK_WEBHOOKS list.

   Follow this instruction to create Slack webhooks and obtain webhook URLs.

   If one would like a Slack notification pushed only if the newly registered API contains a specific tag or tags, one should include the tag key, which should have the value of the specific tag(s) (case sensitive).

   For example:

   "tags": ['translator','biothings'] # will send every time an API is registered with a 'translator' and/or 'biothings' tag 
   

   or

   "tags": 'translator' # will send every time an API is registered with a 'translator' tag 
   

   Finally, to supply your own template instead of using the default Slack Markdown template, please supply the template as a string, with optional variables to be included in a {variable} format. For example:

   "template": "A new API has been registered on SmartAPI.info:\n\n*Title:* {api_title}\n*Description:* {api_description}"
   

   The variables that can be supplied include:

   api_title  # title of registered API 
   api_description # listed describtion of API
   registry_url # url that the API is listed in the SmartAPI registry
   docs_url # url for the API's documentation on SmartAPI.info
   github_user # the github username of the individual that registered the API
   

7. Create index in Python (version 3.x) shell:

   from web.api import es  
   es.create_index()
   

   Or import some API data from a saved dump file. Contact us for the dump file.
   And replace the name of the file in the command with the backup file name.

   from web.api import es
   esq = es.ESQuery()
   esq.restore_all("smartapi_oas3_backup_20200706.json", es.ES_INDEX_NAME)
   

8. Run dev server

   python index.py --debug
   

You should now able to access API dev server at http://localhost:8000