Add OpenAPI Schema for the REST API about naikan HOT 12 CLOSED

Hello i would love to contribute, i even started some contributions already, but to the general docs, i can make a pull request so you can see what i added to the documentation. And i would need to be guided hand-in-hand on how to go about running a request example and generating a response scheme to know what each response signifies. I would run that pull request now.

from naikan.

hello i would love to contribute to this.

from naikan.

Hello @Chizobaonorh! Great to see your here! Thanks, for contributing! Do you need more information? This ticket refers to all controllers with starting with Api*Controller. At the moment they must be two of them.

from naikan.

How to setup this project is described here: https://github.com/enofex/naikan/blob/main/DEVELOPING.md
Sample requests can be found here: https://github.com/enofex/naikan/blob/main/development/naikan-api.http
If the docker compose was started correctly you can see data in it and a configured valid bearer token as well. This you should use for the requests.

The PR is about generating the OpenAPI schema.json for the above described Controllers.

from naikan.

Okay would work in it now.

from naikan.

Hello i am encountering some issues setting up and starting the naikan application, I would need your assistance with that.
@mnhock

from naikan.

Hello, i am having an issue setting up to work on this project, from starting the naikan application and i would need assistance with that @mnhock

from naikan.

What is the exact problem? Have you installed and configured all prerequisites as described in the doc?

from naikan.

from the part of automatically starting dependencies with docker compose

from naikan.

You need docker desktop installed and then start the Spring Boot class described in the doc with the profile dev, -Dspring.profiles.active=dev as JVM parameter.

from naikan.

okay will try this out.

from naikan.

You need docker desktop installed and then start the Spring Boot class described in the doc with the profile dev, -Dspring.profiles.active=dev as JVM parameter.

I can't locate this, i need help with this.

from naikan.