HTTP-service for exploring the Bio4j domain model

Usage

First run the server:

sbt run

then you can try somewhere else:

curl http://localhost:8080/schemas/go
curl http://localhost:8080/schemas/go/properties
curl http://localhost:8080/schemas/go/vertexTypes/GOTerm/properties

or just open one of those links in a browser.

Besides GO module there are some others:

• enzymedb
• go
• ncbiTaxonomy
• refseq
• uniprot (not finished)
• uniprot_enzymedb
• uniprot_go

Request format

http://localhost:8080 returns you the top-level JSON object. Then you can traverse it by appending identifiers to the path.

• if foo is a JSON object, foo/bar/ means accessing it's field bar
• if foo is a JSON array, foo/bar/ means selecting from it an object with "label": "bar"

JSON schema

• top-level object:

  {
      "schemas": [<module>]
  }

• <module>:

  {
      "label": "...",
      "properties": [<property>],
      "dependencies": [<module.label>],
      "vertexTypes": [<vertexType>],
      "edgeTypes": [<edgeType>]
  }

• <property>:

  {
      "label": "...",
      "type": "..."
  }

• <vertexType>:

  {
      "label": "...",
      "properties": [<property.label>]
  }

• <edgeType>:

  {
      "label": "...",
      "properties": [<property.label>],
      "source": {
          "type": <vertexType.label>,
          "arity": <arity>
      },
      "target": {
          "type": <vertexType.label>,
          "arity": <arity>
      }
  }

• <arity>: "one" or "many"