Table of Contents

• Introduction
• Modules
  • Common
    • Installation
    • Guide
  • Server
    • Installation
    • Guide
  • OpenAPI Annotations
    • Installation
    • Guide
  • OpenAPI Annotations Plugin
    • Installation
    • Guide
  • Client
    • Installation
    • Guide

Introduction

Jet is a simple, lightweight, modern, turnkey, Java web client and server library.

Modules

Common

The common module for various Jet modules.

Installation

This module is transitively depended on by the Server and Client modules, so you typically don't need to install this module directly.

For build.gradle.kts:

dependencies {
    implementation("net.jacobpeterson.jet:common:3.2.0")
}

For build.gradle:

dependencies {
    implementation 'net.jacobpeterson.jet:common:3.2.0'
}

For pom.xml:

<dependency>
    <groupId>net.jacobpeterson.jet</groupId>
    <artifactId>common</artifactId>
    <version>3.2.0</version>
</dependency>

Guide

// TODO finish writing guide

Server

A simple, lightweight, modern, turnkey, Java web server library.

Installation

For build.gradle.kts:

dependencies {
    implementation("net.jacobpeterson.jet:server:3.2.0")
}

For build.gradle:

dependencies {
    implementation 'net.jacobpeterson.jet:server:3.2.0'
}

For pom.xml:

<dependency>
    <groupId>net.jacobpeterson.jet</groupId>
    <artifactId>server</artifactId>
    <version>3.2.0</version>
</dependency>

Guide

// TODO finish writing guide

OpenAPI Annotations

A code-first OpenAPI specification annotations library.

Installation

For build.gradle.kts:

dependencies {
    implementation("net.jacobpeterson.jet:openapi-annotations:3.2.0")
}

For build.gradle:

dependencies {
    implementation 'net.jacobpeterson.jet:openapi-annotations:3.2.0'
}

For pom.xml:

<dependency>
    <groupId>net.jacobpeterson.jet</groupId>
    <artifactId>openapi-annotations</artifactId>
    <version>3.2.0</version>
</dependency>

Guide

// TODO finish writing guide

OpenAPI Annotations Plugin

A code-first OpenAPI specification annotations processor Gradle plugin.

Installation

For build.gradle.kts:

plugins {
    id("net.jacobpeterson.jet.openapiannotationsplugin") version "3.2.0"
}

For build.gradle:

plugins {
    id 'net.jacobpeterson.jet.openapiannotationsplugin' version "3.2.0"
}

There is no Maven plugin available at this time.

Guide

This Gradle plugin registers a task named jetOpenApiAnnotations and an extension also named jetOpenApiAnnotations with the following configurations:

javaCompileTasks = <Set<JavaCompile>>

schemaGeneratorConfigBuilderProvider = <SchemaGeneratorConfigBuilderProvider>

schemaGeneratorUseNullableModule = <true or false>

schemaGeneratorUseSchemaNameModule = <true or false>

schemaGeneratorUseGsonModule = <true or false>

schemaGeneratorUseJacksonModule = <true or false>

schemaGeneratorSimpleTypeMappings = <Map<String, String>>

generateOperationId = <DISABLED, FROM_CLASS_METHOD_NAME, FROM_METHOD_AND_PATH, BOTH>

moveClassSchemasToComponents = <true or false>

schemaValidation = <true or false>

outputDirectory = <directory>

outputDirectoryIncludeInJar = <true or false>

Example:

jetOpenApiAnnotations {
    schemaGeneratorUseGsonModule = true
    schemaGeneratorSimpleTypeMappings.put("java.net.InetAddress", """{"type": "string"}""")
}

Client

A simple, lightweight, modern, turnkey, Java web client library.

Installation

For build.gradle.kts:

dependencies {
    implementation("net.jacobpeterson.jet:client:3.2.0")
}

For build.gradle:

dependencies {
    implementation 'net.jacobpeterson.jet:client:3.2.0'
}

For pom.xml:

<dependency>
    <groupId>net.jacobpeterson.jet</groupId>
    <artifactId>client</artifactId>
    <version>3.2.0</version>
</dependency>

Guide

// TODO finish writing guide