Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add explanation of docs on the server to README #148

Merged
merged 1 commit into from
Aug 28, 2021
Merged

Add explanation of docs on the server to README #148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ It also provides a web service front-end for [Owlet](https://github.com/phenosca

* Configuration file template: https://github.com/phenoscape/owlery/blob/master/src/main/resources/application.conf.example
* Your own configuration file can be specified with a JVM argument, e.g.: `-Dconfig.file=/etc/default/owlery.conf`

### Experimenting with the API

* The API description can be found on your server. If your server runs locally on port 8080, you can get the API description at `http://localhost:8080/docs/swagger.json`.
* An interactive version of the API can be found here: `http://localhost:8080/docs/index.html`