[Request] Javadoc and per package documentation on configuration

[ghost]

Hi,

First of all, thank you for the effort put into the project. I'm discovering it through openapitools/openapi-generator, but I'm already having to dive into the code to understand what's going on.

Following the light rest 4j tutorials, it's great that I can start the server, but it's unclear to me for example:

• how the validation handlers are tied in
• which config is necessary and for which package
• what fields I can add or modify of the config
• whether I can rename the config files
• how I can add other light-4j packages and make then work (do I just have to add them to pom.xml? Are there any other steps?)
• how I myself can add handlers:
• do I need to write a HandlerProvider?
• do I just write a handler and it's somehow discovered?
• do I need to somehow register handlers and providers?
• which packages I need to build a minimal server
• etc.

I found the Plugin Architecture doc, but it doesn't answer the questions I have above.

Therefore, I suggest that each package have:

• javadoc (javadoc.io has free hosting for projects on maven central)
• README.md
• docs explaining how to use them

I'll be reading through the code and probably throwing together a pull-request on light-4j or on this repo to get it started, but I'm totally new to the project, so I'd honestly feel more comfortable if it were done by somebody knowledgeable on the subject.

[ghost]

I am just seeing that javadoc exists, but isn't referenced in the docs on the website. That would be one of the TODOs e.g server javadoc

[stevehu]

@LoveIsGrief These are all very good questions. As we are aiming enterprise total solutions, there are a lot of details scattered in the documentation site. I think we need to rework on the getting started for the light-rest-4j which is the framework most people are using. Puting the Javadoc into the document site is another fantastic idea. We are releasing over 100 handlers and components independently so that users can choose whichever is needed. We need to organize the Javadocs for all modules.