Skip to content

Latest commit

 

History

History
114 lines (81 loc) · 2.97 KB

README.MD

File metadata and controls

114 lines (81 loc) · 2.97 KB
Raw

This repository includes an annotation processor designed to extend the functionality of the Javalin library by automatically generating OpenAPI documentation. The goal is to simplify development while using zero reflection.

Features:

  • Automatic OpenAPI Documentation: Automatically generate OpenAPI documentation for your Javalin routes.
  • Zero Reflection: Improve performance and reduce complexity by avoiding reflection.
  • Ease of Development: Simplify the development process with automatic javalin handlers injection.

Add dependency

Latest release

Version

Maven

Make sure you include the repository as well.

  • Dependency

     <dependency>
     <groupId>com.github.qlsolutions.JavalinFly</groupId>
     <artifactId>javalinfly-core</artifactId>
     <version>0.4.0</version>
 </dependency>

  • Annotation processor

     <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-compiler-plugin</artifactId>
     <version>3.8.1</version>
     <configuration>
         <annotationProcessorPaths>
             <annotationProcessorPath>
                 <groupId>com.github.qlsolutions.JavalinFly</groupId>
                 <artifactId>javalinfly-core</artifactId>
                 <version>0.4.0</version>
             </annotationProcessorPath>
         </annotationProcessorPaths>
     </configuration>
 </plugin>
  • Optionally also the kotlin module 
    <dependency>
    <groupId>com.github.qlsolutions.JavalinFly</groupId>
    <artifactId>javalinfly-kotlin</artifactId>
    <version>0.4.0</version>
</dependency>
Gradle

Make sure you include the repository as well.

  • Groovy DSL

    • Dependency
    implementation 'com.github.qlsolutions.JavalinFly:javalinfly-core:0.4.0'
    • Annotation processor
    annotationProcessor 'com.github.qlsolutions.JavalinFly:javalinfly-core:0.4.0'
    • Optionally also the kotlin module 
      implementation 'com.github.qlsolutions.JavalinFly:javalinfly-kotlin:0.4.0'

  • Kotlin DSL

    • Dependency
    implementation("com.github.qlsolutions.JavalinFly:javalinfly-core:0.4.0")
    • Annotation processor
    annotationProcessor("com.github.qlsolutions.JavalinFly:javalinfly-core:0.4.0")
    • Optionally also the kotlin module 
      implementation("com.github.qlsolutions.JavalinFly:javalinfly-kotlin:0.4.0")