kotlin-ktor-rest-api

KO | EN

gitlite — search

#javascript #python #typescript #go #rust #linux #nodejs #awesome #cli #vue #pytorch #openai #ios #open-source

kotlin-ktor-rest-api

(★ 89)

A Modern Kotlin-Ktor RESTful API example. Connects to a PostgreSQL database and uses Exposed framework for database operations.

kotlin-ktor-rest-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kotlin-ktor-rest-api
A Modern Kotlin-Ktor RESTful API example. Connects to a PostgreSQL database and uses Exposed framework for database
operations. Focused on Software Architecture, SOLID Principles, dependency injection, testable code and feature based
development.

- Ktor Framework
- Kotlin
- Dependency Injection -> Koin
- Authorization -> JWT
- Database -> PostgreSQL
- ORM SQL Framework -> Exposed
- Ktor Client -> For External API calls
- Build Tool -> Gradle
- Server -> Tomcat
- Docker support for containerization
- POSTMAN Collection for testing API
- Gradle 7, JDK (Amazon Coretto 11)

# Architecture
![github (6)](https://user-images.githubusercontent.com/86873858/131125468-99d372c5-2b55-473b-9f12-0fbd2c7e9bf7.png)

# Database Credentials (Please add your PostgreSQL credentials here to connect to your database)
resources/application.conf

```
    database {
        exampleDatabaseUrl="jdbc:postgresql://localhost:5432/$YOUR_DB_NAME"
        exampleDatabaseDriver="org.postgresql.Driver"
        exampleDatabaseUser="$YOUR_USERNAME"
        exampleDatabasePassword="$YOUR_PASSWORD"
    }
```
# Features
## - Health Check

**GET /public-api/v1/healthCheck**
&nbsp; Just returns a simple object
## - Authentication

**POST /public-api/v1/authentication/createUser**
&nbsp; Registers a user to the db
**POST /public-api/v1/authentication/login**
&nbsp; Returns a jwt token if success
**GET /api/v1/authentication/userInfo** (Needs Authorization token from login as Authorization header : "Bearer
$token")
&nbsp; Returns the user information
## - Star Wars

**GET /api/v1/star-wars/movie** (Needs Authorization token from login as Authorization header : "Bearer $token")
&nbsp; An External API call example. Returns a movie information from an external api

kotlin-ktor-rest-api

kotlin-ktor-rest-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

kotlin-ktor-rest-api

kotlin-ktor-rest-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README