htwkmooc/poseidon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation of request URLs

Browse Source
This commit is contained in:
Sebastian Serth
2022-07-08 10:12:59 +02:00
parent 39cfdbf635
commit c0a617a383
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/development.md
View File

@ -10,6 +10,16 @@ The project can be compiled using `make build`. This should create a binary whic
Alternatively, the `go run ./cmd/poseidon` command can be used to automatically compile and run the project. Alternatively, the `go run ./cmd/poseidon` command can be used to automatically compile and run the project.
### URLs
Once you completed the project setup, you can check the availability using the following URL:
```http request
http://localhost:7200/api/v1/version
```
Using the prefix `/api/v1`, all routes as described in [API documentation](../api/swagger.yaml) are available and thus can be used in conjunction with [CodeOcean](https://github.com/openHPI/codeocean).
## Tests ## Tests
As testing framework we use the [testify](https://github.com/stretchr/testify) toolkit. As testing framework we use the [testify](https://github.com/stretchr/testify) toolkit.