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

API Documentation #158

Open
georg-schwarz opened this issue Aug 16, 2021 · 1 comment
Open

API Documentation #158

georg-schwarz opened this issue Aug 16, 2021 · 1 comment

Comments

@georg-schwarz
Copy link
Collaborator

On branch wahlzeit-40-new-ui.

We should document the backend API in an interactive way. I suggest to use swagger to generate an OpenApi spec that we can feed into a Swagger-UI container.

@Juliiia
Copy link
Collaborator

Juliiia commented Aug 24, 2021

After we discussed that the wahlzeit-40-new-ui branch is not working, I created a branch (swagger_integration) for swagger integration based on the master branch. Based on the current state a gradle task automatically creates a yaml that includes the API documentation. Currently, a basic yaml will be created. To document the API methods annotations need to be added.

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

No branches or pull requests

2 participants