Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
iBB
API
geneinfoservice
Commits
dc02e116
Commit
dc02e116
authored
Jun 23, 2020
by
tim.tucholski
Browse files
Updated readme
parent
2446a1b3
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
dc02e116
#
g
ene
i
nfo
s
ervice
_new
project
#
G
ene
I
nfo
S
ervice
for the iBeetleBase
project
This project uses Quarkus, the Supersonic Subatomic Java Framework.
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
This microservice is based on Quarkus (version 1.4.2).
It can be used for querying gene information in JSON format.
Currently, it holds gene information for Tribolium castaneum and Drosophila melanogaster.
## Running the application in dev mode
...
...
@@ -10,6 +11,20 @@ You can run your application in dev mode that enables live coding using:
```
./mvnw quarkus:dev
```
## Querying the Service
Once the service is running, gene information can be queried using cURL like this:
```
curl -X GET "http://localhost:8080/geneinfo/current/v1/DATABASE/ID"
```
where DATABASE is either
`tribolium`
or
`flybase`
and ID is the gene identifier.
Gene identifiers can be in TC format (e.g.
`TC016101`
) or in FBgn format (e.g.
`FBgn0010400`
).
Replacing ID with
`identifiers`
returns a list of all gene IDs for the specific database.
Multiple genes can be queried with comma-separated requests:
```
curl -X GET "http://localhost:8080/geneinfo/current/v1/id?=TC016101,TC016102,FBgn10400"
```
## Packaging and running the application
...
...
@@ -27,4 +42,4 @@ Or, if you don't have GraalVM installed, you can run the native executable build
You can then execute your native executable with:
`./target/geneinfoservice_new-1.0-SNAPSHOT-runner`
If you want to learn more about building native executables, please consult https://quarkus.io/guides/building-native-image.
\ No newline at end of file
If you want to learn more about building native executables, please consult https://quarkus.io/guides/building-native-image.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment