SPARQList: Markdown-based highly configurable REST API hosting server for SPARQL (Software presentation at SWAT4HCLS 2017)

1. Software demo
SPARQList: Markdown-based highly
configurable REST API hosting server for
SPARQL
Toshiaki Katayama <ktym@dbcls.jp>
http://jp.linkedin.com/in/toshiakikatayama
Database Center for Life Science (DBCLS),
Joint Support-Center for Data Science Research,
Research Organization of Information and Systems (ROIS), Japan
2017/12/6 @ SWAT4HCLS, Rome

2. SPARQListREST query
SPARQL
endpoint
Parameters SPARQL query
SPARQL resultFormatted result
Data transformation
Query construction
Configuration written in Markdown
* Documentation of the REST API
* SPARQL endpoint(s)
* Query parameter(s) (w/ default values)
* SPARQL query template(s)
* JavaScript data transformation function(s)
* Content-type negotiation

3. Markdown-based configuration
# Title of the API
Some description
## Parameters
* `param_name` description
* default: default value
## Endpoint
SPARQL endpoint URI
## `var_name` description
Some comments
```sparql
SELECT * WHERE {
VALUES ?var { "{{param_name}}" }
...
}
```
## Data transformation (optional)
Content-type negotiation aware JS
snippet
```javascript
({var_name}) =>
{ transformation_function }
```

4. Each REST API configuration is called SPARQLet
written in the Markdown format.
Admin can newly create a API configuration or
just copy those files to the server to host.
ktym@server:sparqlist% tree repository/
repository/
├── adjacent.md
├── bh_chart.md
├── bh_graph.md
├── bh_info.md
├── bh_list.md
├── d3sparql_barchart.md
├── d3sparql_circlepack.md
├── d3sparql_coordmap.md
├── d3sparql_dendrogram.md
├── d3sparql_forcegraph.md
├── d3sparql_htmlhash.md
├── d3sparql_htmltable.md
├── d3sparql_namedmap.md
├── d3sparql_piechart.md
├── d3sparql_roundtree.md
├── d3sparql_sankey.md
├── d3sparql_sunburst.md
├── d3sparql_tree_ec.md
├── d3sparql_treemap.md
├── d3sparql_treemapzoom.md
├── d3sparql_tree_tax.md
├── describe.md
├── sake.md
└── up_interaction_pair.md

5. User of the API can see the documentation on
the Web page such as:
* Name of the API
* Description of the API
* Parameters and default values
* SPARQL endpoint to be used
* SPARQL query to be executed
* JavaScript data transformation function
* Raw Markdown text
Admin can copy, edit and delete the REST API
configuration.
API configuration can contain any Markdown
text to describe the functionalities of the API.

6. Admin can edit the API configuration on the
Web browser or directly modify the Markdown
file resides on the server file system.
# Title of the API
Some description
## Parameters
## Endpoint
## SPARQL query
## JavaScript function

7. User can change parameter values and execute
the API on the Web page or from any Web
client program.
* Execution result will be shown if success
* Stack trace of the execution for debugging

8. SPARQList = Gist for SPARQL & REST API
GitHub https://github.com/dbcls/sparqlist
Each REST API comes with a GUI to execute / stack trace / copy / edit / delete
with a detailed documentation written in the Markdown text.
http://example.org/<sparqlist_path>/<api_name>
API can take multiple parameters and be configured for content-type negotiation
http://example.org/<sparqlist_path>/api/<api_name>?<parameter>=<value>
Please see demos at http://biohackathon.org/rest/ in action.