fleencorp / fleen-feen

Fleen Feen connects you with the world
GNU General Public License v3.0
0 stars 1 forks source link

Add Swagger Documentation to Controllers #30

Open aalamu opened 2 months ago

aalamu commented 2 months ago

Description

Document all controller class methods and there parameters or variables.

Explanation

There are classes in the package

com.fleencorp.feen.controller.

It contains all the application HTTP and REST controllers for interacting with the application.

You will find in the common pakcage

com.fleencorp.feen.controller.common

that it contains a class MiscController

This class contains Open API & Swagger documentations for the route mappings and route methods and variables.

You can go to https://chat.openai.com/ and ask it about any annotation and their purpose, they are very simple to understand.

You can follow the patterns in the MiscController

Note