Develoment Hints

Publish REST API documentation

The documentation of the REST API is created with asciidoc during the gradle build. If you want to publish the current version of the documentation to github pages, run the gradle task "publishGhPages" on the coderadar-webapp module.

Register a *.orm.xml Mapping file

Larger JPQL queries should be externalized into *.orm.xml files since they can be better maintained and formatted in XML rather than within a @Query annotation. Each module (=package) can provide it's own *.orm.xml files. Simply put it into the resources folder (in the same package as the corresponding repository) and create your own implementation of MappingResourceProvider that returns the location of the xml file. The provider has to have a @Component annotation for Spring to pick it up.