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.

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

Document backend APIs #72

Open
gmacario opened this issue Jul 21, 2021 · 1 comment
Open

Document backend APIs #72

gmacario opened this issue Jul 21, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gmacario
Copy link
Collaborator

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.

@gmacario gmacario added the documentation Improvements or additions to documentation label Jul 21, 2021
@gmacario
Copy link
Collaborator Author

gmacario commented Jul 23, 2021

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 How to display webapp frontend? #69)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants