Tkit introduction guide #532
Conversation
GuentherJulian
added
documentation
GuentherJulian
requested review from
EduardKrieger,
mustafaokyay and
rafaelvicariabarker
| = tkit extensions | ||
|
|
||
| 1000kit (tkit) is a set of extensions and plugins for Quarkus. | ||
| It was developed internally by Capgemini, so the source code of the extensions is not publicly available. |
There was a problem hiding this comment.
all our quarkus libs and extensions have publicly available source code(there was issue with gitlab project visibility, fixed now, the group was public already) and are pushed to Maven OSS https://gitlab.com/1000kit/libs/quarkus
|
|
||
| === tkit-quarkus-log-json | ||
|
|
||
| `tkit-quarkus-log-json` provides automatic JSON formatting of log messages. |
There was a problem hiding this comment.
The json log extension provides some additional features that standard quarkus-json logger does not have - e.g. stacktrace spliting, field relabeling, env var output, nested json objects etc but for most projects it is recommended that they use the official json logger instead, unless they need those extra features (like we do in our projects). More info in the README of the lib project
| The `tkit-quarkus-jpa` extension provides base classes for JPA entities (`org.tkit.quarkus.jpa.models.TraceableEntity`) and link:../guide-dao.asciidoc[DAOs] (`org.tkit.quarkus.jpa.daos.AbstractDAO<T>`). | ||
|
|
||
| The `TraceableEntity` implements a string based `ID` and traceable fields such as `version`, `creationDate`, `creationUser` or `modificationDate`. + | ||
| CRUD operation following the DAO pattern are provided by `AbstractDAO<T>`. Your DAO class can simply extend the base class and only needs to implement the business logic. |
There was a problem hiding this comment.
and support for paged queries
| @QuarkusTestResource(DockerComposeTestResource.class) | ||
| public abstract class AbstractTest { | ||
|
|
||
| @DockerService("tkit-parameter") |
There was a problem hiding this comment.
this is only required in native mode testing -when we test our application as a docker image i.e. full integration test. For ,,regular" jvm tests, it is sufficient to annotate a test class with @QuarkusTestResource(DockerComposeTestResource.class)
PR for #486