open-api-eap-template

Introduction: A template project for working with the Ktor OpenAPI prototype
More: Author   ReportBugs   
Tags:

This project was created using the Ktor Project Generator.

Here are some useful links to get you started:

Features

Here's a list of features included in this project:

Name Description
Routing Provides a structured routing DSL
OpenAPI Serves OpenAPI documentation
Content Negotiation Provides automatic content conversion according to Content-Type and Accept headers
kotlinx.serialization Handles JSON serialization using kotlinx.serialization library
Authentication Provides extension point for handling the Authorization header
Authentication OAuth Handles OAuth Bearer authentication scheme

Building & Running

To build or run the project, use one of the following tasks:

Task Description
./gradlew test Run the tests
./gradlew build Build everything
buildFatJar Build an executable JAR of the server with all dependencies included
buildImage Build the docker image to use with the fat JAR
publishImageToLocalRegistry Publish the docker image locally
run Run the server
runDocker Run using the local docker image

If the server starts successfully, you'll see the following output:

2024-12-04 14:32:45.584 [main] INFO  Application - Application started in 0.303 seconds.
2024-12-04 14:32:45.682 [main] INFO  Application - Responding at http://0.0.0.0:8080
Apps
About Me
GitHub: Trinea
Facebook: Dev Tools