aquariophilie/blobfishes

Document backend APIs

Opened this issue · 1 comments

At least add a section in the toplevel README.md which explains how to compile Swagger and the URL where to fetch the generated documentation.

Tested with the following commands

git describe --tags
docker-compose up -d

Result on the console

gmacario@gmpowerhorse:~/github/gmacario/blobfishes (main)$ git describe --tags
v0.0.1-10-g2a53f8d
gmacario@gmpowerhorse:~/github/gmacario/blobfishes (main)$ docker-compose up -d
blobfishes_server_1 is up-to-date
Starting blobfishes_static-pages_1 ... done
gmacario@gmpowerhorse:~/github/gmacario/blobfishes (main)$

So far I have discovered the following endpoints:

URL Example result Notes
http://localhost:3000/ Not Found
http://localhost:3000/api/status {"status":"online"}

@Raffone17 are there any other APIs which are exposed?

More specifically:

  1. Are there any extra APIs which are available when building in development mode?
  2. Under which URL can we get the front-end? (see #69)