Skip to content
Snippets Groups Projects
Commit 27a44e55 authored by Orestis Melkonian's avatar Orestis Melkonian
Browse files

README: API docs part

parent 2b135784
No related branches found
No related tags found
No related merge requests found
......@@ -37,11 +37,16 @@ To run the server API at port 8080:
> stack exec javawlp -- -p 8080 --runServer
```
To query the server (see [API.md](https://git.science.uu.nl/impresshs/javawlp/blob/master/API.md) for available options):
To query the server (see for available options):
```
> curl localhost:8080/compare?a="examples/Main.java:real1"&b="examples/Main.java:real2"
> curl -X POST -d <json_object> <server_url>:8080/compare
```
To get the API docs from the server:
- Markdown: Visit `<server_url>:8080/docs`
- Swagger: Visit ``<server_url>:8080/api-swagger`
- [API.md](https://git.science.uu.nl/impresshs/javawlp/blob/master/API.md)
To run the tests:
```
> stack test
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment